Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 2.27 KB

README.md

File metadata and controls

36 lines (24 loc) · 2.27 KB
Raw

che-workspace-telemetry-client

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.

Project Artifact Name Description Used By
parent parent-$VERSION.pom The POM file of the parent repository (this repo) Not used
backend-base backend-base-$VERSION-resources.zip A zip file containing the telemetry OpenAPI spec in yaml format javascript project (see ./javascript/pom.xml)
backend-base backend-base-$VERSION.jar The compiled backend-base artifact che-workspace-telemetry-woopra-plugin
backend-base backend-base-$VERSION.pom The POM file of the backend-base project che-workspace-telemetry-woopra-plugin
javascript javascript-$VERSION.pom The POM file of the javascript project Not 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