From 1feca6103d2f3cfa0324cf4cdc09f85d23bca42e Mon Sep 17 00:00:00 2001 From: Armin Ruech Date: Wed, 27 Jul 2022 13:07:26 +0200 Subject: [PATCH] Add release instructions to CONTRIBUTING.md Resolves #112 --- CONTRIBUTING.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ab5fec4..1411beea 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,3 +7,27 @@ for general information about the project. ## Prerequisites - Docker + +## Creating a new PR + +If there is a `CHANGELOG.md` file in the component you are updating, +please make sure to add an entry for your change in the "Unreleased" section. + +## Release instructions for maintainers + +1. Add new desired version number in all `CHANGELOG.md` files (instead of "Unreleased") and ensure no (relevant) entries are missing + - This currently only applies to [semantic-conventions/CHANGELOG.md](./semantic-conventions/CHANGELOG.md) +1. Create the release at + 1. Tag: `v0.xx.y` + 1. Title: `Release version 0.xx.y` + 1. Click on _Generate release notes_ + 1. Structure release notes with the headings used in former release notes (since one release applies to multiple distinct components) + 1. Verify that the release looks like expected and hit _Publish release_ +1. Verify the release + - Ensure all workflows in succeeded (branch = the new version tag) + - Ensure all images were pushed to as expected. Currently these are: + - + - + - + - +1. Update the respective version references in the repository, if needed