Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs on creating new releases #287

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add docs on creating new releases #287

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b049246
add docs on creating new releases
oraNod Dec 18, 2024
9941170
Update README.md
oraNod Dec 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,25 @@ 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 that generates the wheel and uploads the release to PyPI.
oraNod marked this conversation as resolved.
Show resolved Hide resolved
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 <NEW_VERSION>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about signed tags ?

git push --tags upstream
```

samccann marked this conversation as resolved.
Show resolved Hide resolved
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.
Loading