bind9/.gitlab/issue_templates/Release.md

Release Schedule

Code Freeze:

Tagging Deadline:

Public Release:

Documentation Review Links

Closed issues assigned to the milestone without a release note:

Merge requests merged into the milestone without a release note:

Merge requests merged into the milestone without a CHANGES entry:

Release Checklist

Before the Code Freeze

• (QA) Rebase -S editions on top of current open-source versions: git checkout bind-9.18-sub && git rebase origin/bind-9.18
• (QA) Inform Support and Marketing of impending release (and give estimated release dates).
• (QA) Ensure there are no permanent test failures on any platform. Check public and private scheduled pipelines.
• (QA) Check Perflab to ensure there has been no unexplained drop in performance for the versions being released.
• (QA) Check whether all issues assigned to the release milestone are resolved¹ .
• (QA) Ensure that there are no outstanding merge requests in the private repository¹ (Subscription Edition only).
• (QA) Ensure all merge requests marked for backporting have been indeed backported.
• (QA) Announce (on Mattermost) that the code freeze is in effect.

Before the Tagging Deadline

• (QA) Ensure release notes are correct, ask Support and Marketing to check them as well. Example
• (QA) Add a release marker to CHANGES. Examples: 9.18, 9.16
• (QA) Add a release marker to CHANGES.SE (Subscription Edition only). Example
• (QA) Update BIND 9 version in configure.ac (9.18+) or version (9.16).
• (QA) Rebuild configure using Autoconf on docs.isc.org (9.16).
• (QA) Update GitLab settings for all maintained branches to disallow merging to them: public, private
• (QA) Tag the releases in the private repository (git tag -s -m "BIND 9.x.y" v9.x.y).

Before the ASN Deadline (for ASN Releases) or the Public Release Date (for Regular Releases)

• (QA) Check that the formatting is correct for HTML and PDF versions of release notes.
• (QA) Check that the formatting of the generated man pages is correct.
• (QA) Verify GitLab CI results for the tags created and sign off on the releases to be published.
• (QA) Update GitLab settings for all maintained branches to allow merging to them again: public, private
• (QA) Prepare and merge MRs resetting the release notes and updating the version string for each maintained branch: 9.16 and newer
• (QA) Announce (on Mattermost) that the code freeze is over.
• (QA) Request signatures for the tarballs, providing their location and checksums. Ask signers on Mattermost.
• (Signers) Ensure that the contents of tarballs and tags are identical.
• (Signers) Validate tarball checksums, sign tarballs, and upload signatures.
• (QA) Verify tarball signatures and check tarball checksums again: Run publish_bind.sh on repo.isc.org to pre-publish.
• (Support) Pre-publish ASN and/or Subscription Edition tarballs so that packages can be built.
• (QA) Build and test ASN and/or Subscription Edition packages (in cloudsmith branch in private repo). Example
• (QA) Prepare the patches/ subdirectory for each security release (if applicable).
• (QA) Notify Support that the releases have been prepared.
• (Support) Send out ASNs (if applicable).

On the Day of Public Release

• (Support) Wait for clearance from Security Officer to proceed with the public release (if applicable).
• (Support) Place tarballs in public location on FTP site.
• (Support) Publish links to downloads on ISC website. Example
• (Support) Add the new releases to the vulnerability matrix in the Knowledge Base.
• (Support) Write release email to bind-announce. Example
• (Support) Write email to bind-users (if a major release). Example
• (Support) Send eligible customers updated links to the Subscription Edition (update the -S edition delivery tickets, even if those links were provided earlier via an ASN ticket).
• (Support) Update tickets in case of waiting support customers.
• (QA) Build and test any outstanding private packages in private repo. Example
• (QA) Build public RPMs. Example commit which triggers Copr builds automatically
• (SwEng) Build Debian/Ubuntu packages.
• (SwEng) Update Docker files here and make sure push is synchronized to GitHub. Docker Hub should pick it up automatically. Example
• (QA) Inform Marketing of the release.
• (Marketing) Post a short note to Mastodon.
• (Marketing) Update Wikipedia entry for BIND.
• (Marketing) Write blog article (if a major release).
• (QA) Ensure all new tags are annotated and signed. git show --show-signature v9.19.12
• (QA) Push tags for the published releases to the public repository.
• (QA) Merge published release tags (non-linearly) back into the their relevant development/maintenance branches. Step 7 of the new workflow
• (QA) Sanitize confidential issues which are assigned to the current release milestone and do not describe a security vulnerability, then make them public.
• (QA) Sanitize confidential issues which are assigned to older release milestones and describe security vulnerabilities, then make them public if appropriate² .
• (QA) Update QA tools used in GitLab CI (e.g. Black, PyLint, Sphinx) by modifying the relevant Dockerfile.
• (QA) Run a pipeline to rebuild all images used in GitLab CI.
• (QA) Update metadata.json with the upcoming release information.

---

1. If not, use the time remaining until the tagging deadline to ensure all outstanding issues are either resolved or moved to a different milestone. ↩︎

2. As a rule of thumb, security vulnerabilities which have reproducers merged to the public repository are considered okay for full disclosure. ↩︎