Skip to content

Latest commit

 

History

History
42 lines (32 loc) · 2.13 KB

RELEASE.md

File metadata and controls

42 lines (32 loc) · 2.13 KB

Release Process

Scaffolding a New Release

When planning a spec release a maintainer should:

  1. Create a milestone for the release (e.g. Buildpack 0.5)
  2. Create a release branch from main branch with name <spec>/<version> (e.g. buildpack/0.5) or extensions/<spec>/version> for extension specifications.
  3. Update the version of the relevant spec in README.md and the specification file (e.g. see commit 791363e).
  4. Push the branch to the repo.

Release Planning

Issues that are scheduled for a given release should be added to the milestone. The core team will regularly review and adjust the contents of upcoming milestones at the weekly core team sync.

Accepting Contributions to a Release

When a PR is opened, the first core team member to review should:

  1. Convert to draft if the PR implements an issue that has not been scheduled in a milestone.
  2. Ensure the PR is pointed at the correct branch.
  3. Request changes if the PR modifies any of the other specifications.
  4. Add the PR to a milestone, if this was not done already.
  5. Add the matching api/* label if this was not done already (e.g. api/buildpack )

Spec changes must be approved by a super-majority of the core team.

Finalizing the Release

When all issues and PRs in a given milestone are complete, a core team member may:

  1. Create a PR to "finalize" the release, merge the release branch to main.
  2. Create a draft release and write release notes.

Approving the Final Release

All core team members and any interested maintainers should:

  1. Review the release in its entirety and provide last minute feedback as needed.
  2. Review the release notes if they desire.
  3. Approve the final PR.

Cutting the Release

Once the final PR has the required approvals, the person that opened it should:

  1. Merge the PR.
  2. Publish the release.
  3. Close the milestone.
  4. Delete the release branch.