diff --git a/docs/guides/python/release.md b/docs/guides/python/release.md index ee22628..313bd75 100644 --- a/docs/guides/python/release.md +++ b/docs/guides/python/release.md @@ -1,19 +1,25 @@ -Thanks to the integrations which are in place, it is very easy to release a newer version of ansible-lint. +# Release process for python packages -Anyone with appropriate permission to the `ansible-lint` project will be able to rollout a new release. +Thanks to the integrations which are in place, it is very easy to release a newer version of our python projects i.e. [ansible-lint], [ansible-navigator], [ansible-compat] and [molecule]. -If we go to the Github releases section, we'll be able to see something like: +[ansible-lint]:https://github.com/ansible/ansible-lint +[ansible-navigator]:https://github.com/ansible/ansible-navigator +[ansible-compat]:https://github.com/ansible/ansible-compat +[molecule]:https://github.com/ansible-community/molecule -![Screenshot 2023-05-16 at 5 18 25 PM](https://github.com/ansible/devtools/assets/11896437/4052c662-3db3-4847-98f1-8187ae9ba10f) +Anyone with appropriate permission to the respective projects will be able to rollout a new release. -This shows the latest available version for `ansible-lint`. -Also shows the upcoming version with changes to be included in the next release. +If we go to the Github **Releases** section, we'll be able to see something like: + +![Release draft](release_draft.png) + +This shows the upcoming version with changes to be included in the next release. We use [release-drafter](https://github.com/release-drafter/release-drafter) which helps us to get the changelog for the releases. When a PR is merged, release-drafter runs and adds PR details to the changelog as shown above. # Releasing a new version -Go to Github releases and release it! while being sure that you create a discussion thread for it. This will create a *tag. +Go to `Draft a new release` inside Github releases and release it! while being sure that you create a discussion thread for it. This will create a new tag. Once released, the latest version will be deployed and published to PyPI registry. -This release process is the same for all our python based projects. +This release process is applicable to all our python based projects. diff --git a/docs/guides/python/release_draft.png b/docs/guides/python/release_draft.png new file mode 100644 index 0000000..88e9660 Binary files /dev/null and b/docs/guides/python/release_draft.png differ