open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update release instructions (#1778)

This commit is contained in:
Trask Stalnaker 2025-01-22 10:15:11 -08:00 committed by GitHub
parent 8d43ef0bcc
commit 578c4bf60b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
RELEASING.md
View File

@ -1,4 +1,6 @@
# Making a Release # Releasing
## Preparing a new release
- Close the [release milestone](https://github.com/open-telemetry/semantic-conventions/milestones) - Close the [release milestone](https://github.com/open-telemetry/semantic-conventions/milestones)
if there is one. if there is one.
@ -7,17 +9,13 @@
if needed. if needed.
- Run [opentelemetry.io workflow](https://github.com/open-telemetry/opentelemetry.io/actions/workflows/build-dev.yml) - Run [opentelemetry.io workflow](https://github.com/open-telemetry/opentelemetry.io/actions/workflows/build-dev.yml)
against `semantic-conventions` submodule as a smoke-test for docs. Fix broken links, if any. against `semantic-conventions` submodule as a smoke-test for docs. Fix broken links, if any.
- Create a staging branch for the release. - Run the [prepare release workflow](https://github.com/open-telemetry/semantic-conventions/actions/workflows/prepare-release.yml).
- Update `schema-next.yaml` file and move to `schemas/{version}` - Review and merge the pull request that it creates.
- Ensure the `next` version is appropriately configured as the `{version}`. - Note: the PR will need to be closed and the workflow re-run if any non-chore PRs are merged to `main` while the PR is open.
- Copy `schema-next.yaml` to `schemas/{version}`.
- Add `next` as a version in `schema-next.yaml` version. ## Making the release
- Run `make chlog-update VERSION=v{version}`
- `make chlog-update` will clean up all the current `.yaml` files inside the - Create a [new release](https://github.com/open-telemetry/semantic-conventions/releases/new):
`.chloggen` folder automatically
- Double check that `CHANGELOG.md` is updated with the proper `v{version}`
- Send staging branch as PR for review.
- After the release PR is merged, create a [new release](https://github.com/open-telemetry/semantic-conventions/releases/new):
- Set title and tag to `v{version}` - Set title and tag to `v{version}`
- Set target to the commit of the merged release PR - Set target to the commit of the merged release PR
- Copy changelog to the release notes - Copy changelog to the release notes