From 485f9ff6ea2cf0f5d0a4b175c5d67b11bd0ef4c1 Mon Sep 17 00:00:00 2001 From: Don Naro Date: Tue, 14 Jan 2025 22:08:00 +0000 Subject: [PATCH] Add docs on creating new releases (#287) * add docs on creating new releases * Update README.md Co-authored-by: Sandra McCann * update for signed tags --------- Co-authored-by: Sandra McCann --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 49ffb581..fdcb1dc7 100644 --- a/README.md +++ b/README.md @@ -19,3 +19,27 @@ Before installing these plugins be sure that you uninstall their old standalone packages, like `pip3 uninstall molecule-azure`. If you fail to do so, you will end-up with a broken setup, as multiple plugins will have the same entry points, registered. + +## Creating new releases + +The `release.yml` workflow generates the wheel and uploads the release to PyPI. +Here are the steps you need to kick that process off: + +1. Review the commit logs and decide on the next version. + - Breaking changes should increment to a new major version. + - New features should increment to a new minor version. + - Bug fixes and small changes should increment to a new patch version. + +2. Create a new tag and push it to the repo. + + ```bash + git tag -s -m "Tag message" + git push --tags upstream + ``` + + > It is possible to create lightweight tags using `git tag ` but signed tags are preferred. + +3. Publish the release with either the GitHub CLI or in a browser. + See the [GitHub documentation about managing releases](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository). +4. Check the [release workflow](https://github.com/ansible-community/molecule-plugins/actions/workflows/release.yml) runs successfully. +5. Verify the new version is available from the [molecule-plugins](https://pypi.org/project/molecule-plugins/) page on PyPI.