From 7bdd13ee79c44e4801d978edcf68b6257ccd3c76 Mon Sep 17 00:00:00 2001
From: Jonas L <jooola@users.noreply.github.com>
Date: Tue, 4 Jul 2023 11:52:16 +0200
Subject: [PATCH] docs: add more details to release process (#249)

* docs: add more details to release process

* use a single commit command
---
 README.md | 35 +++++++++++++++++++++++++++--------
 1 file changed, 27 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 263f47f..ee4e7fa 100644
--- a/README.md
+++ b/README.md
@@ -55,11 +55,30 @@ ansible-test integration --color --local  -vvv hcloud_server // Executed all int
 
 ## Releasing a new version
 
-### Generating changelog from fragments
-
-1. Check if the changelog fragments are available (there should be files in `changelogs/fragments`)
-2. Run `antsibull-changelog release --version <version>`, it should remove all fragments and change
-   the `changelogs/changlog.yaml` and `CHANGELOG.rst`
-3. Push the changes to the main branch
-4. Tag the release through the Github UI, after this the Github Actions will run and publish the collection to Ansible
-   Galaxy
+1. Make sure your local `main` branch is in a clean state and is up to date.
+2. Define a new version:
+   ```sh
+   export HCLOUD_VERSION=1.15.0
+   ```
+3. Create a release branch:
+   ```sh
+   git checkout -b "release-$HCLOUD_VERSION"
+   ```
+4. Generate the changelog for the new version, it should remove all fragments and change
+   the `changelogs/changelog.yaml` and `CHANGELOG.rst`:
+   ```sh
+   antsibull-changelog release --version "$HCLOUD_VERSION"
+   git add changelogs/changelog.yaml changelogs/fragments CHANGELOG.rst
+   ```
+5. Update the `version` in the ansible galaxy metadata file:
+   ```sh
+   sed -i "s/^version: .*/version: $HCLOUD_VERSION/" galaxy.yml
+   git add galaxy.yml
+   ```
+6. Commit the changes:
+   ```sh
+   git commit -m "chore: prepare v$HCLOUD_VERSION"
+   ```
+7. Push the changes to Github, open a Pull Request and follow the process to get the PR merged into `main`.
+8. Once the PR is merged, tag the release through the Github UI, after this the Github Actions will run and publish the collection to Ansible
+   Galaxy.