Skip to content

Commit d76f5d5

Browse files
[chore] clarify new release instructions (open-telemetry#2047)
* clear up new release * remove duplicated line break --------- Co-authored-by: Juliano Costa <julianocosta89@outlook.com>
1 parent 4195d3b commit d76f5d5

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

CONTRIBUTING.md

+17-14
Original file line numberDiff line numberDiff line change
@@ -286,20 +286,23 @@ make build-multiplatform-and-push
286286

287287
Maintainers can create a new release when desired by following these steps.
288288

289-
- [Create a new
290-
release](https://github.com/open-telemetry/opentelemetry-demo/releases/new),
291-
creating a new tag in the format `x.x.x` based on main. Automatically generate
292-
release notes. Prepend a summary of the major changes to the release notes.
293-
- After images for the new release are built and published, create a new Pull
294-
Request that updates the `IMAGE_VERSION` environment variable in `.env` to the
295-
_new_ version number, and update the `CHANGELOG.md` with the new version
296-
leaving the `Unreleased` section for the next release.
297-
- Create a new Pull Request to update the deployment of the demo in the
298-
[OpenTelemetry Helm
299-
Charts](https://github.com/open-telemetry/opentelemetry-helm-charts) repo.
300-
- After the Helm chart is released, create a new Pull Request which updates the
301-
Demo's Kubernetes manifest by running `make generate-kubernetes-manifests` and
302-
committing the changes.
289+
1. Create a Pull Request that updates the `IMAGE_VERSION` environment variable
290+
in `.env` to the _new_ version number based on the format `x.x.x` and merge
291+
it.
292+
2. [Create a new
293+
release](https://github.com/open-telemetry/opentelemetry-demo/releases/new),
294+
creating a new tag for the _new_ version number based on main. Automatically
295+
generate release notes. Prepend a summary of the major changes to the release
296+
notes.
297+
3. After images for the new release are built and published, create a new Pull
298+
Request that updates the `CHANGELOG.md` with the new version leaving the
299+
`Unreleased` section for the next release.
300+
4. Create a new Pull Request to update the deployment of the demo in the
301+
[OpenTelemetry Helm
302+
Charts](https://github.com/open-telemetry/opentelemetry-helm-charts) repo.
303+
5. After the Helm chart is released, create a new Pull Request which updates the
304+
Demo's Kubernetes manifest by running `make generate-kubernetes-manifests`
305+
and committing the changes.
303306

304307
[docs]: https://opentelemetry.io/docs/demo/
305308

0 commit comments

Comments
 (0)