Document the automated release process #381
Conversation
|
The current preview of the new page can be seen here: https://ansible--381.org.readthedocs.build/projects/ansible-build-data/automated-process/ (link valid as long as PR is open) |
|
Maybe we should already move the "Create porting guide PR" to after merging the ansible-build-data PR? This will be necessary for the automated porting guide PR workflow that's currently under construction (ansible/ansible-documentation#121). |
There was a problem hiding this comment.
This is awesome, thanks @felixfontein!
I added a few suggestions.
|
Are there any more comments on this? Or should I merge the current version? |
|
I'll try to give it a look later today. |
docs/automated-process.md
Outdated
| 1. Trigger [the automated workflow](https://github.com/ansible-community/ansible-build-data/actions/workflows/ansible-release.yml) on the **Actions** tab of the repository and specify the release version, such as 11.2.0, and the major version, such as 11. | ||
| The process will create a PR in the [`ansible-build-data` repository](https://github.com/ansible-community/ansible-build-data/). | ||
| Afterwards it will wait for approval before continuing with uploading the package to PyPI. | ||
| All users with commit rights in the `ansible-build-data` repository will be informed with a notification once the approval is needed. |
There was a problem hiding this comment.
I believe only @ansible-community/release-management-wg is notified.
There was a problem hiding this comment.
Why do you think so? That group isn't mentioned in the workflow, so I would assume that GH notifies everyone with appropriate rights, which probably is the set of folks with commit rights.
There was a problem hiding this comment.
I believe that's how the environment that @anweshadas created is set up. It's set in the repo settings, not the workflow file.
There was a problem hiding this comment.
@anweshadas can you confirm this?
There was a problem hiding this comment.
Why do you think so? That group isn't mentioned in the workflow, so I would assume that GH notifies everyone with appropriate rights, which probably is the set of folks with commit rights.
In GitHub Environments, there's protection rules, of which one is "required reviewers". These are listed as GitHub usernames or teams. The maximum is 6 entries. Whoever is listed will be notified, I don't think this will notify accounts that aren't in those teams or lists.
There was a problem hiding this comment.
I don't have any way to verify this (I don't have access to the settings), so can someone with appropriate access please check this and confirm (or say what else it is)?
There was a problem hiding this comment.
I don't have enough privileges in this repo to check this :(
Maybe @oraNod does?
There was a problem hiding this comment.
Hi, plz excuse the delayed response. Just getting back from PTO...
It looks like @gotmax23 is correct and only folks in the ansible-community/release-management-wg group are notified. Here's a screenshot of the required reviewers section of the environment:
On a side note, I'm surprised that @felixfontein and @webknjaz don't have sufficient repo permissions. Should we address that?
There was a problem hiding this comment.
Thanks a lot! I've updated the paragraph in 81cc678 and added a footnote explaining how this is configured.
Regarding repo permissions: I wouldn't mind having more permissions :) I have no idea who currently has more permissions and why the permissions are as they are...
Co-authored-by: Don Naro <dnaro@redhat.com>
Co-authored-by: Maxwell G <maxwell@gtmx.me>
|
I still don't know how to adjust #381 (comment) since I do not have access to the repository settings. @anweshadas or anyone else with sufficient rights, can you please check out which names and/or groups are listed as "Required reviewers" for the second workflow step, and how exactly the setting looks like (so we can describe it in the documentation - will make it easier to later validate for someone with appropriate access who didn't set this up)? |
|
If nobody objects, I'm going to merge this soon. The current preview of the new page is here: https://ansible--381.org.readthedocs.build/projects/ansible-build-data/automated-process/ |
|
Thanks everyone for reviewing and figuring things out :) |
|
Thanks @felixfontein ! |
Based on comments of @gotmax23 in the #release-management:ansible.com room.