3.24 release tracking issue

[davejrt]

3.24 Release

This release is scheduled for Jan 20, 2021, 6:00 PM (UTC).

---

Note: All yarn run release ... commands should be run from folder dev/release.

Note: All yarn run test ... commands should be run from folder web.

Setup

• Ensure release configuration in dev/release/release-config.jsonc on main is up to date with the parameters for the current release.
• Ensure you have the latest version of the release tooling and configuration by checking out and updating sourcegraph@main.

Jan 14, 2021, 6:00 PM (UTC) (5 work days before release): Prep for branch cut

• Post a release status update to Slack - review all release-blocking issues, and ensure someone is resolving each.

  yarn run release release:status

Jan 15, 2021, 6:00 PM (UTC) (4 work days before release): Branch cut

• Update the changelog and merge the generated pull request:

  yarn run release changelog:cut

• Create the 3.24 branch off the CHANGELOG commit in the previous step: git branch 3.24 && git push origin 3.24.

Upon branch cut, create and test the first release candidate:

• Tag the first release candidate:

  yarn run release release:create-candidate 1

• Wait for the Sourcegraph pipeline, QA pipeline, and E2E pipeline in Buildkite to complete.
• File any failures and regressions in the pipelines as release-blocker issues and assign the appropriate teams.

Revert or disable features that may cause delays. As necessary, git cherry-pick bugfix (not feature!) commits from main into the release branch. Continue to create new release candidates daily or as necessary, until no more release-blocker issues remain:

• Cut the Nth release candidate:

  N=<release-candidate-number> yarn run release release:create-candidate $N

• Re-run the automated test suite against the new release candidate, file any regressions as
  release-blocker issues.
  • If necessary, manually test features or workflows affected by the cherry-pick.
• Post a release status update by running the command below. Ensure someone is resolving each release-blocking issue. If there are no more release-blocking issues, proceed to tag the final release in the next section.

  yarn run release release:status
  

Tag final release

Once there are no more release-blocking issues (as reported by the release:status command) proceed with creating the final release:

• Verify the CHANGELOG on
  main is accurate (no items should have been added since branch cut, but some items may need to
  be removed).
• Tag the final release:

  yarn run release release:create-candidate final

• Wait for the release Docker images to be available in Docker Hub.
• Open PRs that publish the new release and address any action items required to finalize draft PRs (track PR status via the generated release campaign):

  yarn run release release:stage

Jan 20, 2021, 6:00 PM (UTC): Release

• From the release campaign, merge the release-publishing PRs created previously.
  • For deploy-sourcegraph, also:
    • Tag the v3.24.0 release at the most recent commit on the v3.24 branch.

      VERSION='v3.24.0' bash -c 'git tag -a "$VERSION" -m "$VERSION" && git push origin "$VERSION"'

  • For sourcegraph, also:
    • Cherry pick the release-publishing PR from sourcegraph/sourcegraph@main into the release branch.
• Ask the product team to merge the blog post (example). Add the pull request to the release campaign:

  yarn run release release:add-to-campaign sourcegraph/about <pr-number>

• Finalize and announce that the release is live:

  yarn run release release:close

Post-release

Notify the next release captain that they are on duty for the next release. They should complete the steps in this section.

• Open a PR to update dev/release/release-config.jsonc with the parameters for the current release.
• Ensure you have the latest version of the release tooling and configuration by checking out and updating sourcegraph@main.
• Create release calendar events, tracking issue, and announcement for next release:

  yarn run release tracking:issues
  yarn run release tracking:timeline

• Close this issue.

Note: If a patch release is requested after the release, ask that a patch request issue be filled out and approved first.

[bobheadxi]

@davejrt do you mind if we merge https://github.com/sourcegraph/sourcegraph/pull/17401 before doing the post-release steps here?

[davejrt]

@davejrt do you mind if we merge #17401 before doing the post-release steps here?

For sure! Go ahead.

[davejrt]

Sourcegraph 3.24.0 has been published

• Changelog: https://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/CHANGELOG.md#3-24-0
• Release campaign: https://k8s.sgdev.org/organizations/sourcegraph/campaigns/release-sourcegraph-3.24.0

@davejrt: Please complete the post-release steps before closing this issue.