Skip to content

Commit

Permalink
docs: update releasing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pichlermarc committed Dec 18, 2024
1 parent d77f0ad commit 69675f8
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/contributing/releasing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ We aim to eventually automate this process as much as possible.

1. Go to the [Release PR Workflow](https://github.com/open-telemetry/opentelemetry-js/actions/workflows/create-or-update-release-pr.yml)
2. Click "Run workflow"
3. For `Branch`, select the branch you want to release from, `main` (current major) or `1.x` (if you back-ported something)
3. For `Release Type`, select if you want to create a release PR for a new `minor` or `patch` version.
4. For `Release Scope`, select if you want to release
- `experimental` (all packages under `./experimental/packages`)
Expand All @@ -26,11 +27,11 @@ We aim to eventually automate this process as much as possible.
## 3. Publish to NPM

> [!IMPORTANT]
> This step will publish anything that's on `main` IF AND ONLY IF the version has been bumped. If the version for a package
> This step will publish anything that's on the branch you're releasing from IF AND ONLY IF the version has been bumped. If the version for a package
> has not been bumped, it will not publish a new version of the package.
1. Go to the [NPM publish workflow](https://github.com/open-telemetry/opentelemetry-js/actions/workflows/publish-to-npm.yml)
2. Click "Run workflow" (from main)
2. Click "Run workflow" (from `main` or `v1.x`, based on what branch you chose to create the release PR for)
1. In rare cases not all packages are published due to a race when publishing, if you suspect this to
be the case, re-run the workflow: there should be enough time from 1.

Expand Down

0 comments on commit 69675f8

Please sign in to comment.