Skip to content

Commit

Permalink
Update release documentation.
Browse files Browse the repository at this point in the history
Prepare bugfix release.
  • Loading branch information
robin-checkmk committed May 30, 2022
1 parent 2470da2 commit f4b0fbe
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 3 deletions.
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion galaxy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit f4b0fbe

Please sign in to comment.