-
Notifications
You must be signed in to change notification settings - Fork 685
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
Update release documentation about release_helper.py script #10502
Update release documentation about release_helper.py script #10502
Conversation
The release documentation was updated to include the new script intended to help maintainers during the release process. Examples of the release_helper.py script were included in each task automated by it.
Code Climate has analyzed commit c2221ed and detected 0 issues on this pull request. The test coverage on the diff in this pull request is 100.0% (50% is the threshold). This pull request will bring the total coverage in the repository to 52.4% (0.0% change). View more on Code Climate. |
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.
Thanks for the documentation. It looks very useful. Please take a look at my comments. The one sentence per line comment applies through the changes made in this PR.
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.
Hello @marcusburghardt and thank you for the documentation update. I have offered few suggestions, please consider them. But in general it looks good.
This script was created targeting automation of boring tasks and reduction of human errors while allowing release process to be executed much faster with a lower knowledge curve. | ||
|
||
There are still space for improvements and any contribution is welcome. Here are some ideas to start contributing: | ||
* Include an option to automate the process of updating the **stable** branch |
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.
As I am looking at those ideas, wouldn't it be better to create them as upstream issues? I am not sure that they will be discovered here.
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.
It is also a good idea to create them as upstream issues. Some improvements are relatively simple. I will review them soon (before the next release). After this review, if something remains in this list or if new ideas appear, I can file upstream issues for them.
Wording improvements suggested by reviewers. Co-authored-by: vojtapolasek <krecoun@gmail.com> Co-authored-by: Matthew Burket <m@tthewburket.com>
/packit build |
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.
Thank you for nice documentation and examples. PR looks good to me, merging.
I always appreciate some good docs. Thanks for creating this! |
Description:
The release documentation was updated to metion the new script intended to help maintainers during the release process.
Examples of the
release_helper.py
script were included in each task automated by it.Rationale:
Easier and faster release process