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

Add instructions for incompatible changes #460

Merged
merged 1 commit into from
Jan 31, 2019
Merged

Add instructions for incompatible changes #460

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 26 additions & 0 deletions docs/release-playbook.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,32 @@ Do these steps once per release.
should be cherry-picked, any remaining issues should become release
blockers.

### Update the status of GitHub issues for incompatible changes

In the below, _X.Y_ is a release you are cutting.

#### Start new migration windows

1. Search for all [open "incompatible-change" issues that have "migration-ready" labels](https://github.com/bazelbuild/bazel/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3Aincompatible-change+label%3Amigration-ready)
philwo marked this conversation as resolved.
Show resolved Hide resolved
1. For each such issue:
1. Add a "migration-_X.Y_" label.
katre marked this conversation as resolved.
Show resolved Hide resolved
2. Add a "breaking-change-_X.Y+w_" label where _w_ is the length of migration window for that particular issue
2. Remove "migration-ready" label

#### Review breaking changes

1. Search for issues with label "breaking-change-_X.Y_".
2. For all such issues that are **closed**, verify that the flag is flipped and release notes mention the breaking change.
2. For all such issues that are still **open**:
1. remove the label "breaking-change-_X.Y_".
1. add a label "migration-_X.Y_" and "breaking-change-_X.Y+1_" (this prolongs the migration window by 1 release).
1. Reach out to the issue owner.

#### Prolong ongoing migration windows

1. Search for issues with labels "migration-_X.Y-1_" that are not "breaking-change-_X.Y_"
2. For all such issues, apply "migration-_X.Y_" label.

### Create a Candidate

Create candidates with the release.sh script.
Expand Down