Mirrors/ansible-collection-hetzner-hcloud
2
0
Fork 0
mirror of https://github.com/ansible-collections/hetzner.hcloud synced 2024-12-13 22:12:32 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: add more details to release process (#249)

Browse source 
* docs: add more details to release process

* use a single commit command
This commit is contained in:
Jonas L 2023-07-04 11:52:16 +02:00 committed by GitHub
parent 98022020a1
commit 7bdd13ee79
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -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.