-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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.
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
Automate release tag, changelog and man pages #61031
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
it looks like the tag annotation was |
ab3f3a4
to
dedc2b5
Compare
I don't see a reason why we need the tag annotation to say "Version 3005" versus using "v3005". Looks like the github action is pending a PR mathieudutour/github-tag-action#23 here to add the feature to add a custom annotated tag message. If there is no need for "Version 3005" I think we are okay to go forward with this. |
@Ch3LL Wondering about that definition to use Python 3.8, file .github/workflows/release-tag.yml lines 44-48. While it would be great for Centos 7 and 8, Centos 9 is using Python 3.9, Ubuntu 22.04 is probably going to be using Python 3.9 too, or maybe Python 3.10 like Fedora 35 , 36. Until Tiamat packaging is the only available packages, I believe we need to allow for the OS provided Python 3 version so long as it is 3.8 or greater. Or is that Python 3.8 just for the GitHub Actions ? |
@dmurphy18 it's GH Actions specific, nothing to do with whatever python versions salt supports |
ping @krionbsd would changing the annotation tag impact packaging at all? I verified that changing the tag annotation does not impact the salt version:
|
no, it shouldn't impact packaging |
What does this PR do?
Use Github Actions to help automate some release tasks. Both of these Github Actions are manually triggered, with the release version and other inputs required.
This Github Action will generate the changelog, add the changelog to the release notes and generate the man pages. If the man pages do not need to be generated you can set man pages to false in the inputs. Once all the docs are generated it will create a PR automatically. Here is the PR that was created on my repo:
Ch3LL#16
There are still some improvements that could be made to this:
a. Detect if the release file has not been created and add the required 3005 banner at the top of the release notes file.
b. If re-generating the docs for a re-tag, figure out how to automatically add the changelog entries to the correct place. Right now this will require manually updating the PR.
This Github Action will create a 3005 tag and github release. It will also build and generate the salt tar ball. If its a re-tag, you can set retag to be true and it will delete the previous 3005 tag and release before generating the new tag and github release.