che-workspace-telemetry-client

April 18, 2023 ยท View on GitHub

Contribute

This repository contains an abstract telemetry API and a Typescript implementation of the API.

Releasing

Whenever a commit is pushed to master, the GitHub Action defined in publish.yaml is run. This installs maven, increments the versions in each POM, builds the projects, creates a release commit, and runs mvn deploy. This job pushes a number of artifacts to the GitHub package repository for this repository.

ProjectArtifact NameDescriptionUsed By
parentparent-$VERSION.pomThe POM file of the parent repository (this repo)Not used
backend-basebackend-base-$VERSION-resources.zipA zip file containing the telemetry OpenAPI spec in yaml formatjavascript project (see ./javascript/pom.xml)
backend-basebackend-base-$VERSION.jarThe compiled backend-base artifactche-workspace-telemetry-woopra-plugin
backend-basebackend-base-$VERSION.pomThe POM file of the backend-base projectche-workspace-telemetry-woopra-plugin
javascriptjavascript-$VERSION.pomThe POM file of the javascript projectNot used

After the maven artifacts are published, the GitHub Action runs npm publish in the javascript project to push a new version of @eclipse-che/workspace-telemetry-client

To use the new version in the woopra plugin, replace the version coordinate in pom.xml:

<dependency>
  <groupId>org.eclipse.che.incubator.workspace-telemetry</groupId>
  <artifactId>backend-base</artifactId>
  <version>      </version>
</dependency>

For information about the abstract Java API, see this README

Trademark

"Che" is a trademark of the Eclipse Foundation