X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/53d9bace12b3aa230820c869a079020b4608c945..33f0d9e79a098442135478b07b182a966f60375e:/docs/contributing/release_process.md diff --git a/docs/contributing/release_process.md b/docs/contributing/release_process.md index 718ea3d..6a4b868 100644 --- a/docs/contributing/release_process.md +++ b/docs/contributing/release_process.md @@ -8,9 +8,11 @@ explain what everything does and how to release _Black_ using said automation. To cut a release, you must be a _Black_ maintainer with `GitHub Release` creation access. Using this access, the release process is: -1. Cut a new PR editing `CHANGES.md` to version the latest changes - 1. Example PR: https://github.com/psf/black/pull/2192 - 2. Example title: `Update CHANGES.md for XX.X release` +1. Cut a new PR editing `CHANGES.md` and the docs to version the latest changes + 1. Remove any empty sections for the current release + 2. Add a new empty template for the next release (template below) + 3. Example PR: [#2616](https://github.com/psf/black/pull/2616) + 4. Example title: `Update CHANGES.md for XX.X release` 2. Once the release PR is merged ensure all CI passes 1. If not, ensure there is an Issue open for the cause of failing CI (generally we'd want this fixed before cutting a release) @@ -32,6 +34,60 @@ access. Using this access, the release process is: If anything fails, please go read the respective action's log output and configuration file to reverse engineer your way to a fix/soluton. +## Changelog template + +Use the following template for a clean changelog after the release: + +``` +## Unreleased + +### Highlights + + + +### Style + + + +### Preview style + + + +### _Blackd_ + + + +### Configuration + + + +### Documentation + + + +### Integrations + + + +### Output + + + +### Packaging + + + +### Parser + + + +### Performance + + + +``` + ## Release workflows All _Blacks_'s automation workflows use GitHub Actions. All workflows are therefore