ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-19 13:07:56 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
882f197306
tahoe-lafs/docs/release-checklist.rst
fenn-cs 882f197306 format updates 
Signed-off-by: fenn-cs <fenn25.fn@gmail.com>
2021-10-30 13:37:58 +01:00

8.9 KiB
Raw Blame History

Release Checklist

This release checklist specifies a series of checks that anyone engaged in releasing a version of Tahoe should follow.

Any contributor can do the first part of the release preparation. Only certain contributors can perform other parts. These are the two main sections of this checklist (and could be done by different people).

A final section describes how to announce the release.

This checklist is based on the original instructions (in old revisions in the file docs/how_to_make_a_tahoe-lafs_release.org).

Any Contributor

Anyone who can create normal PRs should be able to complete this portion of the release process.

Prepare for the Release

The master branch should always be releasable.

It may be worth asking (on IRC or mailing-ist) if anything will be merged imminently (for example, "I will prepare a release this coming Tuesday if you want to get anything in").

  • Create a ticket for the release in Trac
  • Ticket number needed in next section

Get a clean checkout

The release proccess involves compressing source files and putting them in formats suitable for distribution such as .tar.gz and zip. That said, it's neccesary to the release process begins with a clean checkout to avoid making a release with previously generated files.

  • Inside the tahoe root dir run git clone . ../tahoe-release-x.x.x where (x.x.x is the release number such as 1.16.0).

The above command would create a new directory at the same level as your original clone named ``tahoe-release-x.x.x``. You could name the folder however you want but it would be a good practice to give it the release name. You MAY also discard this directory once the release process is complete.

  • cd into the release directory and install dependencies by running python -m venv venv && source venv/bin/activate && pip install --editable .[test]

Create Branch and Apply Updates

  • Create a branch for the release/candidate (e.g. XXXX.release-1.16.0)
  • run tox -e news to produce a new NEWS.txt file (this does a commit)
  • create the news for the release
    • newsfragments/<ticket number>.minor
    • commit it
  • manually fix NEWS.txt
    • proper title for latest release ("Release 1.16.0" instead of "Release ...post1432")
    • double-check date (maybe release will be in the future)
    • spot-check the release notes (these come from the newsfragments files though so don't do heavy editing)
    • commit these changes
  • update "relnotes.txt"
    • update all mentions of 1.16.0 to new and higher release version for example 1.16.1
    • update "previous release" statement and date
    • summarize major changes
    • commit it
  • update "nix/tahoe-lafs.nix"
    • change the value given for version from OLD.post1 to NEW.post1
  • update "docs/known_issues.rst" if appropriate
  • update "docs/Installation/install-tahoe.rst" references to the new release
  • Push the branch to github
  • Create a (draft) PR; this should trigger CI (note that github doesn't let you create a PR without some changes on the branch so running + committing the NEWS.txt file achieves that without changing any code)
  • Confirm CI runs successfully on all platforms

Preparing to Authenticate Release (Setting up GPG)

Skip the section if you already have GPG setup.

In other to keep releases authentic it's required that releases are signed before being published. This ensure's that users of Tahoe are able to verify that the version of Tahoe they are using is coming from a trusted or at the very least known source.

The authentication is done using the GPG implementation of OpenGPG to be able to complete the release steps you would have to download the GPG software and setup a key(identity).

  • Download and install GPG for your operating system.
  • Generate a key pair using gpg --gen-key. Some questions would be asked to personalize your key configuration.

You might take additional steps including:

  • Setting up a revocation certificate (Incase you lose your secret key)
  • Backing up your key pair
  • Upload your fingerprint to a keyserver such as openpgp.org

Create Release Candidate

Before "officially" tagging any release, we will make a release-candidate available. So there will be at least 1.15.0rc0 (for example). If there are any problems, an rc1 or rc2 etc may also be released. Anyone can sign these releases (ideally they'd be signed "officially" as well, but it's better to get them out than to wait for that).

Typically expert users will be the ones testing release candidates and they will need to evaluate which contributors' signatures they trust.

  • (all steps above are completed)
  • sign the release
    • git tag -s -u 0xE34E62D06D0E69CFCA4179FFBDE0D31D68666A7A -m "release Tahoe-LAFS-1.16.0rc0" tahoe-lafs-1.16.0rc0

Replace the key-id above with your own, which can simply be your email if's attached your fingerprint. Don't forget to put the correct tag message and name in this example the tag message is "release Tahoe-LAFS-1.16.0rc0" and the tag name is `tahoe-lafs-1.16.0rc0`

  • build all code locally
    • these should all pass:
      • tox -e py27,codechecks,docs,integration
    • these can fail (ideally they should not of course):
      • tox -e deprecations,upcoming-deprecations
  • build tarballs
    • tox -e tarballs
    • Confirm that release tarballs exist by runnig: ls dist/ | grep 1.16.0rc0
  • inspect and test the tarballs
    • install each in a fresh virtualenv
    • run tahoe command
  • when satisfied, sign the tarballs:
    • gpg --pinentry=loopback --armor --detach-sign dist/tahoe_lafs-1.16.0rc0-py2.py3-none-any.whl
    • gpg --pinentry=loopback --armor --detach-sign dist/tahoe_lafs-1.16.0rc0.tar.gz

Privileged Contributor

Steps in this portion require special access to keys or infrastructure. For example, access to tahoe-lafs.org to upload binaries or edit HTML.

Hack Tahoe-LAFS

Did anyone contribute a hack since the last release? If so, then https://tahoe-lafs.org/hacktahoelafs/ needs to be updated.

Sign Git Tag

  • git tag -s -u 0xE34E62D06D0E69CFCA4179FFBDE0D31D68666A7A -m "release Tahoe-LAFS-X.Y.Z" tahoe-lafs-X.Y.Z

Upload Artifacts

Any release-candidate or actual release plus signature (.asc file) need to be uploaded to https://tahoe-lafs.org in ~source/downloads

  • secure-copy all release artifacts to the download area on the tahoe-lafs.org host machine. ~source/downloads on there maps to https://tahoe-lafs.org/downloads/ on the Web.
  • scp dist/1.15.0 username@tahoe-lafs.org:/home/source/downloads
  • the following developers have access to do this:
    • exarkun
    • meejah
    • warner

For the actual release, the tarball and signature files need to be uploaded to PyPI as well.

  • how to do this?
  • (original guide says only twine upload dist/*)
  • the following developers have access to do this:
    • warner
    • exarkun (partial?)
    • meejah (partial?)

Announcing the Release Candidate

The release-candidate should be announced by posting to the mailing-list (tahoe-dev@lists.tahoe-lafs.org). For example: https://lists.tahoe-lafs.org/pipermail/tahoe-dev/2020-October/009978.html

Is The Release Done Yet?

If anyone reports a problem with a release-candidate then a new release-candidate should be made once a fix has been merged to master. Repeat the above instructions with rc1 or rc2 or whatever is appropriate.

Once a release-candidate has marinated for some time then it can be made into a the actual release.

The actual release follows the same steps as above, with some differences:

  • there is no "-rcX" on the end of release names
  • the release is uploaded to PyPI (using Twine)
  • the version is tagged in Git (ideally using "the tahoe release key" but can be done with any of the authorized core developers' personal key)
  • the release-candidate branches must be merged back to master after the release is official (e.g. causing newsfragments to be deleted on master, etc)

Announcing the Release

mailing-lists

A new Tahoe release is traditionally announced on our mailing-list (tahoe-dev@tahoe-lafs.org). The former version of these instructions also announced the release on the following other lists:

wiki

Edit the "News" section of the front page of https://tahoe-lafs.org with a link to the mailing-list archive of the announcement message.