Skip to content

Latest commit

 

History

History
72 lines (52 loc) · 2.97 KB

RELEASING.md

File metadata and controls

72 lines (52 loc) · 2.97 KB
Raw

How to release packages in this repo

This repository holds multiple npm packages (though npm workspaces are not being used). Currently each package releases independently -- i.e. their versioning is not tied to each other. A release of a package consists of (a) a repo git tag at the appropriate commit and (b) one or more release artifacts (typically a release published to npmjs.com).

By far the primary package in this repo is @elastic/opentelemetry-node. The tag name for a release of the primary package will not use a prefix; other packages will use a prefix (the basename of the npm package name). For example,

Package Tag Pattern Examples
@elastic/opentelemetry-node v* v1.0.0
@elastic/mockotlpserver mockotlpserver-v* mockotlpserver-v0.2.0
@elastic/opentelemetry-instrumentation-openai instrumentation-openai-v* instrumentation-openai-v0.3.0

How to release @elastic/opentelemetry-node

Assuming "x.y.z" is the release verison:

  1. Choose the appropriate version number according to semver.

  2. Create a PR with these changes:

    • Bump the "version" in "packages/opentelemetry-node/package.json".
    • Run npm install in "packages/opentelemetry-node/" to update "packages/opentelemetry-node/package-lock.json".
    • Update "packages/opentelemetry-node/CHANGELOG.md" as necessary.
    • Name the PR something like "release @elastic/[email protected]".

  3. Get the PR approved and merged.

  4. Working on the elastic repo (not a fork), tag the commit as follows:

    git tag vx.y.z
git push origin vx.y.z

    The GitHub Actions "release" workflow will handle the release steps -- including the npm publish. See the appropriate run at: https://github.com/elastic/elastic-otel-node/actions/workflows/release.yml

How to release other packages

Assuming:

  • VERSION="x.y.z" is the release version and
  • PKGSUBDIR="instrumentation-openai" is the package being released. (Note that the PKGSUBDIR, the directory under "packages/" is not necessarily the basename of the npm package.)

  1. Choose the appropriate version number according to semver.

  2. Create a PR with these changes:

    • Bump the "version" in "packages/$PKGSUBDIR/package.json".
    • Run npm install in "packages/$PKGSUBDIR/" to update "packages/$PKGSUBDIR/package-lock.json".
    • Update "packages/$PKGSUBDIR/CHANGELOG.md" as necessary.
    • Name the PR something like "release $PKGSUBDIR x.y.z".

  3. Get the PR approved and merged.

  4. Working on the elastic repo (not a fork), tag the commit as follows:

    git tag $PKGSUBDIR-vx.y.z
git push origin $PKGSUBDIR-vx.y.z

    The GitHub Actions "release-$PKGSUBDIR" workflow will handle the release steps -- including the npm publish. See the appropriate run at: https://github.com/elastic/elastic-otel-node/actions