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

Jump to bottom

Update release documentation about release_helper.py script #10502

Merged
merged 3 commits into from
Apr 28, 2023
Merged

Update release documentation about release_helper.py script #10502

merged 3 commits into from
Apr 28, 2023

Conversation

marcusburghardt
Copy link
Member

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

@marcusburghardt
Update release documentation about release_helper
c2221ed 
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.
@marcusburghardt marcusburghardt added the Documentation Update in project documentation. label Apr 27, 2023
@marcusburghardt marcusburghardt added this to the 0.1.68 milestone Apr 27, 2023
@github-actions
Copy link

Start a new ephemeral environment with changes proposed in this pull request:

Fedora Environment
Open in Gitpod

Oracle Linux 8 Environment
Open in Gitpod

@codeclimate
Copy link

codeclimate bot commented Apr 27, 2023

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.

@vojtapolasek vojtapolasek self-assigned this Apr 27, 2023
Mab879
Mab879 requested changes Apr 27, 2023
View reviewed changes
Copy link
Member

@Mab879 Mab879 left a 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.

docs/release_process.md Outdated Show resolved Hide resolved
docs/release_process.md Outdated Show resolved Hide resolved
vojtapolasek
vojtapolasek requested changes Apr 27, 2023
View reviewed changes
Copy link
Collaborator

@vojtapolasek vojtapolasek left a 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.

docs/release_process.md Outdated Show resolved Hide resolved
docs/release_process.md Outdated Show resolved Hide resolved
docs/release_process.md Outdated Show resolved Hide resolved
docs/release_process.md
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
Copy link
Collaborator

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.

Copy link
Member Author

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.

docs/release_process.md Outdated Show resolved Hide resolved
marcusburghardt and others added 2 commits April 28, 2023 09:02
@marcusburghardt @vojtapolasek @Mab879
Apply suggestions from code review
defe42f 
Wording improvements suggested by reviewers.

Co-authored-by: vojtapolasek <krecoun@gmail.com>
Co-authored-by: Matthew Burket <m@tthewburket.com>
@marcusburghardt
Style Guide alignment: one sentence per line
3c6c0f8
@marcusburghardt
Copy link
Member Author

/packit build

vojtapolasek
vojtapolasek approved these changes Apr 28, 2023
View reviewed changes
Copy link
Collaborator

@vojtapolasek vojtapolasek left a 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.

@Mab879 Mab879 self-assigned this Apr 28, 2023
@Mab879
Copy link
Member

Mab879 commented Apr 28, 2023

I always appreciate some good docs. Thanks for creating this!

@Mab879 Mab879 merged commit f31f137 into ComplianceAsCode:master Apr 28, 2023
33 checks passed
@marcusburghardt marcusburghardt deleted the release_doc_with_script branch April 28, 2023 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mab879 Mab879 Mab879 approved these changes

@vojtapolasek vojtapolasek vojtapolasek approved these changes

Assignees

@Mab879 Mab879

@vojtapolasek vojtapolasek

Labels
Documentation Update in project documentation.
Projects
None yet
Milestone
0.1.68
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@marcusburghardt @Mab879 @vojtapolasek