Skip to content

More concise wording for expedited releases #462

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

Open
bdelacretaz wants to merge 3 commits into
base: main
Choose a base branch
from
Open

More concise wording for expedited releases #462

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9938267
More concise wording for expedited releases
bdelacretaz Mar 14, 2025
e9ed763
Clarify that it's the PMC's decision
bdelacretaz Mar 17, 2025
03f33d9
Re-add the 'volunteers in multiple time zones' bit as requested
bdelacretaz Mar 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 15 additions & 23 deletions content/legal/release-policy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,36 +44,28 @@ requirements of ASF policy on releases as described below, validate all
cryptographic signatures, compile as provided, and test the result on their
own platform.

Release votes SHOULD remain open for at least 72 hours. See the next
[Expedited Releases](#expedited-releases) section when considering a reduced
voting period.
Unless there are strong reasons to expedite a release, as described below,
release votes SHOULD remain open for at least 72 hours, to give PMC members
(volunteers spread around multiple time zones, with lives and jobs)
enough time to participate.

Copy link
Contributor

@sebbASF sebbASF Mar 20, 2025

Choose a reason for hiding this comment

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

Does not read well to me. I think the last two lines should be swapped

#### Expedited Releases {#expedited-releases}
As stated above, the normal policy for releases is to allow 72 hours for
release reviews and votes, however the review/voting period for a release
can be reduced in exceptional circumstances.
The review and voting period for a release can be reduced in
exceptional circumstances.

ASF projects are made up of distributed teams, in multiple time zones and volunteers
with lives and jobs and the rationale behind 72 hours is to try and give all
members of a project the opportunity to take part in the decision to release.
Comment on lines -56 to -58
Copy link
Contributor

@markt-asf markt-asf Mar 14, 2025

Choose a reason for hiding this comment

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

Adding this additional explanation was a deliberate decision.

Copy link
Contributor

@niallkp niallkp Mar 16, 2025

Choose a reason for hiding this comment

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

As @markt-asf said, this came out of the threads on members@ and at least a few people wanted any explanation of why for the 72h period. I added the paragraph as part of building a consensus on changing the docs, but personally I'm fine with removing it.

Copy link
Member Author

@bdelacretaz bdelacretaz Mar 17, 2025

Choose a reason for hiding this comment

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

The explanation is present above, "release votes SHOULD remain open for at least 72 hours, to give PMC members enough time to participate.". Re-adding it here is a duplicate, which I think should be avoided in a policy document.

Copy link
Member Author

@bdelacretaz bdelacretaz Mar 17, 2025

Choose a reason for hiding this comment

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

If you want to make sure people don't miss the reasons for 72 hours if they read just this section, maybe change "The review and voting period for a release" to "The review and voting period for a release (72 hours by default, see above)" ? I think it's better to avoid duplicating information in such a document.

Copy link
Contributor

@markt-asf markt-asf Mar 17, 2025

Choose a reason for hiding this comment

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

+1 to adding the text in parentheses. I'd still like to see the "multuiple timezones and volunteers with lives and jobs" text in there somewhere. Maybe more it (or something like it) to the paragraph that explains the 72 hour default?

Copy link
Member Author

@bdelacretaz bdelacretaz Mar 19, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Good point, I have re-added that bit in commit #03f33d9

A typical example is a release that fixes publicly known or
critical exploitable security issues, but the PMC can decide
what constitutes an exceptional circumstance.

The most obvious example of an exceptional circumstance would be for a fix for a
publicly known or critical, easily exploitable security issue. Everyone will probably have a different definition
of what an exceptional circumstance is, but ultimately it is down to individual
PMCs to decide for their project.
Comment on lines -60 to -63
Copy link
Contributor

@markt-asf markt-asf Mar 14, 2025

Choose a reason for hiding this comment

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

A key motivator for the previous change was to provide an explicit example.

Copy link
Member Author

@bdelacretaz bdelacretaz Mar 17, 2025

Choose a reason for hiding this comment

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

Changed this to clarify that the PMC can decide, which says the same as previously but in a more precise & concise way.

PMCs SHOULD give as much notice as possible to their project members
when doing an expedited release.

Projects SHOULD give as much notice as possible for an expedited release in
order to give project members a chance to make time to participate in the
decision.

Comment on lines +60 to -68
Copy link
Contributor

@niallkp niallkp Mar 16, 2025

Choose a reason for hiding this comment

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

Looks good to me

Emails calling for a Release Vote that run for less than 72 hours MUST include
Emails calling for a Release Vote that runs for less than 72 hours MUST include
Comment on lines -69 to +63
Copy link
Contributor

@markt-asf markt-asf Mar 14, 2025

Choose a reason for hiding this comment

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

+1 to this typo fix

an explanation of why the release is being expedited.

This policy already states that deviations from normal policy MUST be reported to
the Board, but it is worth emphasising this here specifically for release votes
with a reduced voting time. Unless there are pressing reasons to inform the Board
earlier, reporting can be done in the project's next scheduled board report.

Expedited releases are deviations from normal policy, and as such MUST be reported
to the Board, in the project's next scheduled Board report, unless the PMC wants
to report earlier.
Comment on lines -72 to +68
Copy link
Contributor

@niallkp niallkp Mar 16, 2025

Choose a reason for hiding this comment

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

+1 to this rewording


### Publication {#publication}

Expand Down