Skip to content

Commit

Permalink
Add instructions for incompatible changes (bazelbuild#460)
Browse files Browse the repository at this point in the history
  • Loading branch information
dslomov authored and joeleba committed Jun 17, 2019
1 parent f72b9d1 commit f3787da
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/release-playbook.md
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)
1. For each such issue:
1. Add a "migration-_X.Y_" label.
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

0 comments on commit f3787da

Please sign in to comment.