From f4b0fbe45d3896622b46ebb9074ffdd9acaf3d5d Mon Sep 17 00:00:00 2001 From: Robin Gierse Date: Mon, 30 May 2022 14:06:06 +0200 Subject: [PATCH] Update release documentation. Prepare bugfix release. --- CONTRIBUTING.md | 15 ++++++++++++++- .../{trailing_slash.ymk => trailing_slash.yml} | 2 +- galaxy.yml | 2 +- 3 files changed, 16 insertions(+), 3 deletions(-) rename changelogs/fragments/{trailing_slash.ymk => trailing_slash.yml} (95%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 90500efa6..a3ed821e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -54,7 +54,20 @@ at files in the folder `changelogs/archive`. ### Documentation Documentation is still a work in progress. -For modules please use the inline documentation as seen in the existing modules. +Module documentation is compiled during a release and stored as `docs/module.rst`, +but this is not ideal yet. However, please use the inline documentation as seen +in the existing modules when creating additional modules. + +## Releasing this collection +Releasing this collection is automated using GitHub Actions. +Before running the action `Release Collection` against the `main` branch, the +following needs to be done: + +1. Update the collection version in `galaxy.yml`. Look for `version:`. +2. Double check `changelogs/fragments` if all changes have a changelog. +3. After all changes have been performed, merge them into the `main` branch. +4. Release the collection by running the action `Release Collection` against the `main` branch. +5. Merge the automatically created pull request and update the `devel` branch from `main`. ## Code of Conduct diff --git a/changelogs/fragments/trailing_slash.ymk b/changelogs/fragments/trailing_slash.yml similarity index 95% rename from changelogs/fragments/trailing_slash.ymk rename to changelogs/fragments/trailing_slash.yml index a94ed6770..8d88e46e8 100644 --- a/changelogs/fragments/trailing_slash.ymk +++ b/changelogs/fragments/trailing_slash.yml @@ -1,6 +1,6 @@ # https://docs.ansible.com/ansible/latest/community/development_process.html#changelogs-how-to bugfixes: - - the host mnodule can now handle the trailing slash in the folder path returned by the REST API. + - The host module can now handle the trailing slash in the folder path returned by the REST API. # known_issues: # - This release is still in development and a heavy work in progress. diff --git a/galaxy.yml b/galaxy.yml index e0e842300..3c0ee0018 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -9,7 +9,7 @@ namespace: tribe29 name: checkmk # The version of the collection. Must be compatible with semantic versioning -version: 0.3.2 +version: 0.3.3 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection readme: README.md