Skip to content

Commit 578c4bf

Browse files
authored
Update release instructions (#1778)
1 parent 8d43ef0 commit 578c4bf

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

RELEASING.md

+10-12
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# Making a Release
1+
# Releasing
2+
3+
## Preparing a new release
24

35
- Close the [release milestone](https://github.com/open-telemetry/semantic-conventions/milestones)
46
if there is one.
@@ -7,17 +9,13 @@
79
if needed.
810
- Run [opentelemetry.io workflow](https://github.com/open-telemetry/opentelemetry.io/actions/workflows/build-dev.yml)
911
against `semantic-conventions` submodule as a smoke-test for docs. Fix broken links, if any.
10-
- Create a staging branch for the release.
11-
- Update `schema-next.yaml` file and move to `schemas/{version}`
12-
- Ensure the `next` version is appropriately configured as the `{version}`.
13-
- Copy `schema-next.yaml` to `schemas/{version}`.
14-
- Add `next` as a version in `schema-next.yaml` version.
15-
- Run `make chlog-update VERSION=v{version}`
16-
- `make chlog-update` will clean up all the current `.yaml` files inside the
17-
`.chloggen` folder automatically
18-
- Double check that `CHANGELOG.md` is updated with the proper `v{version}`
19-
- Send staging branch as PR for review.
20-
- After the release PR is merged, create a [new release](https://github.com/open-telemetry/semantic-conventions/releases/new):
12+
- Run the [prepare release workflow](https://github.com/open-telemetry/semantic-conventions/actions/workflows/prepare-release.yml).
13+
- Review and merge the pull request that it creates.
14+
- 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.
15+
16+
## Making the release
17+
18+
- Create a [new release](https://github.com/open-telemetry/semantic-conventions/releases/new):
2119
- Set title and tag to `v{version}`
2220
- Set target to the commit of the merged release PR
2321
- Copy changelog to the release notes

0 commit comments

Comments
 (0)