Skip to content

Commit

Permalink
Move release instructions to RELEASING.md (#1762)
Browse files Browse the repository at this point in the history
  • Loading branch information
trask authored Jan 20, 2025
1 parent eae7a31 commit b810141
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 28 deletions.
28 changes: 0 additions & 28 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ requirements and recommendations.
- [Update the tables of content](#update-the-tables-of-content)
- [Markdown link check](#markdown-link-check)
- [Updating the referenced specification version](#updating-the-referenced-specification-version)
- [Making a Release](#making-a-release)
- [Merging existing ECS conventions](#merging-existing-ecs-conventions)

<!-- tocstop -->
Expand Down Expand Up @@ -415,33 +414,6 @@ make markdown-link-check
4. Run the script from the root directory, e.g. `semantic-conventions$ ./internal/tools/update_specification_version.sh`.
5. Add all modified files to the change submit and submit a PR.

## Making a Release

- Ensure the referenced specification version is up to date. Use
[tooling to update the spec](#updating-the-referenced-specification-version)
if needed.
- 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.
- Create a staging branch for the release.
- Update `schema-next.yaml` file and move to `schemas/{version}`
- Ensure the `next` version is appropriately configured as the `{version}`.
- Copy `schema-next.yaml` to `schemas/{version}`.
- Add `next` as a version in `schema-next.yaml` version.
- Run `make chlog-update VERSION=v{version}`
- `make chlog-update` will clean up all the current `.yaml` files inside the
`.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 target to the commit of the merged release PR
- Copy changelog to the release notes
- Verify that the release looks like expected
- Publish release

New release is then auto-discovered by [opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io) pipelines which (via bot-generated PR)
eventually results in new version of schema file being published.

## Merging existing ECS conventions

The Elastic Common Schema (ECS) is being merged into OpenTelemetry Semantic
Expand Down
26 changes: 26 additions & 0 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Making a Release

- Ensure the referenced specification version is up to date. Use
[tooling to update the spec](./CONTRIBUTING.md#updating-the-referenced-specification-version)
if needed.
- 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.
- Create a staging branch for the release.
- Update `schema-next.yaml` file and move to `schemas/{version}`
- Ensure the `next` version is appropriately configured as the `{version}`.
- Copy `schema-next.yaml` to `schemas/{version}`.
- Add `next` as a version in `schema-next.yaml` version.
- Run `make chlog-update VERSION=v{version}`
- `make chlog-update` will clean up all the current `.yaml` files inside the
`.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 target to the commit of the merged release PR
- Copy changelog to the release notes
- Verify that the release looks like expected
- Publish release

New release is then auto-discovered by [opentelemetry.io](https://github.com/open-telemetry/opentelemetry.io) pipelines which (via bot-generated PR)
eventually results in new version of schema file being published.

0 comments on commit b810141

Please sign in to comment.