Skip to content

Commit

Permalink
Add stable tag process to release process documentation
Browse files Browse the repository at this point in the history
- Add reasoning + step commands
  • Loading branch information
cooperlees committed May 11, 2021
1 parent 2f52e4b commit a3e64d7
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion docs/contributing/release_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
_Black_ has had a lot of work automating its release process. This document sets out to
explain what everything does and how to release _Black_ using said automation.

## Cutting a Relase
## Cutting a Release

To cut a release, you must be a _Black_ maintainer with `GitHub Release` creation
access. Using this access, the release process is:
Expand Down Expand Up @@ -70,3 +70,19 @@ to download the executable for their platform and run _Black_ without a
The created binaries are attached/stored on the associated
[GitHub Release](https://github.com/psf/black/releases) for download over _IPv4 only_
(GitHub still does not have IPv6 access 😢).

## Moving the `stable` tag

_Black_ provides a stable tag for people who want to move along as _Black_ developers see a version become reliable.
Here the _Black_ developers will move once the release has been problem free for at least ~24 hours from release.
Given the large _Black_ userbase we hear about bad bugs quickly. We do strive to continually improve our CI too.

### Tag moving process

#### stable

From a rebased `main` checkout:

1. `git tag -f stable VERSION_TAG`
1. e.g. `git tag -f stable 21.5b1`
2. `git push --tags -f`

0 comments on commit a3e64d7

Please sign in to comment.