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.

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

Add stabilization phase description to developers guide #11234

Merged
merged 2 commits into from
Nov 1, 2023

Conversation

mildas
Copy link
Contributor

@mildas mildas commented Oct 31, 2023

Description:

Initially, the description was published as discussion.

Rationale:

Stabilization phase is performed before every release. It is defined process that should be described in developers guide so anyone can read about it.

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

@Mab879 Mab879 added this to the 0.1.71 milestone Oct 31, 2023
@Mab879 Mab879 added the Documentation Update in project documentation. label Oct 31, 2023
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.

Just style guide things.

Thanks for the PR!

docs/manual/developer/10_stabilization_phase.md Outdated Show resolved Hide resolved
docs/manual/developer/10_stabilization_phase.md Outdated Show resolved Hide resolved
docs/manual/developer/10_stabilization_phase.md Outdated Show resolved Hide resolved
docs/manual/developer/10_stabilization_phase.md Outdated Show resolved Hide resolved
docs/manual/developer/10_stabilization_phase.md Outdated Show resolved Hide resolved
docs/manual/developer/10_stabilization_phase.md Outdated Show resolved Hide resolved
@Mab879 Mab879 self-assigned this Oct 31, 2023
Copy link
Member

@marcusburghardt marcusburghardt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @mildas . Just take a look at Matthew's comments.

## Duration
Current duration is set to **2 weeks**. This duration is approximate. Complications such as newly discovered major issues during this period might slightly prolong it.

The duration is tied to release cadence. The more time between release, the more time for stabilization is needed. Thus, the current 2 weeks stabilization is for release every 2 months. However, stabilization period does not affect release cadence. Next release date will be the same as there would not be any prolongation.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now I agree with this sentence The more time between release, the more time for stabilization is needed. but it should be reviewed in the future because along the time we can also optimize the stabilization phase and therefore the cadence should have minimal impact on time demanded for stabilization phase.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, with optimized stabilization phase it will take less time. But even then the highlighted sentence will be true. For example we can get to 1 week long stabilization for release every 2 months, but if we change cadence to 3 months, the stabilization will need to be slightly prolonged as the chance of problems will be higher.

Copy link
Member

@marcusburghardt marcusburghardt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mildas mildas force-pushed the stabilization_in_guide branch 3 times, most recently from 7391068 to fc9bedc Compare November 1, 2023 10:19
@mildas mildas force-pushed the stabilization_in_guide branch from fc9bedc to 2f679ba Compare November 1, 2023 10:20
@mildas
Copy link
Contributor Author

mildas commented Nov 1, 2023

Thanks for the feedback. I've addressed style guide issues and added reference to Release process guide.

Copy link

codeclimate bot commented Nov 1, 2023

Code Climate has analyzed commit 2f679ba 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 58.4%.

View more on Code Climate.

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 PR!

Copy link
Member

@marcusburghardt marcusburghardt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@Mab879 Mab879 merged commit 1bccd61 into ComplianceAsCode:master Nov 1, 2023
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Update in project documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants