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

Update release management guidelines #8

Merged
merged 1 commit into from
Sep 29, 2020
Merged

Conversation

eloquence
Copy link
Member

@eloquence eloquence commented Sep 24, 2020

Status

Ready for review.

This fleshes out the guide for collaborating with the Communications Manager on a release, including the preparatory steps of creating a docs PR with release-specific upgrade instructions.

It also encapsulates the one trade-off with our current branching/tagging strategy: in some cases, we may have to create a release-specific branch to ensure we don't pick up documentation changes in main that are not yet releasable. This is likely to be rare, but it can happen.

This PR also includes a small README update to clarify that this repository is no longer in beta.

@conorsch
Copy link
Contributor

First pass looks pretty darn good. Had some trouble verifying this step:

bumps the SecureDrop version of the documentation using the update_version.sh script in that repository

but that's attributable to freedomofpress/securedrop#5530, not a flaw in the docs here. Still, will want to verify that functionality prior to finalizing review.

@eloquence
Copy link
Member Author

Marking as ready now that freedomofpress/securedrop#5520 is merged.

@eloquence eloquence marked this pull request as ready for review September 29, 2020 01:16
Copy link
Contributor

@zenmonkeykstop zenmonkeykstop left a comment

Choose a reason for hiding this comment

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

LGTM with one teeny nit

Copy link
Contributor

@zenmonkeykstop zenmonkeykstop left a comment

Choose a reason for hiding this comment

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

LGTM with one teeny nit

@eloquence
Copy link
Member Author

(Squashed into one commit)

Copy link
Contributor

@zenmonkeykstop zenmonkeykstop left a comment

Choose a reason for hiding this comment

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

LGTM, approving

@zenmonkeykstop zenmonkeykstop merged commit 85bd632 into main Sep 29, 2020
@conorsch conorsch mentioned this pull request Sep 29, 2020
@eloquence eloquence deleted the release-mgmt branch October 9, 2020 19:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants