release process: formalize the changelog template (#2837)
I did this manually for the last few releases and I think it's going to be helpful in the future too. Unfortunately this adds a little more work during the release (sorry @cooperlees). This change will also improve the merge conflict situation a bit, because changes to different sections won't merge conflict. For the last release, the sections were in a kind of random order. In the template I put highlights and "Style" first because they're most important to users, and alphabetized the rest.
This commit is contained in:
parent
cae7ae3a4d
commit
afc0fb05cb
39
CHANGES.md
39
CHANGES.md
@ -2,11 +2,50 @@
|
||||
|
||||
## Unreleased
|
||||
|
||||
### Highlights
|
||||
|
||||
<!-- Include any especially major or disruptive changes here -->
|
||||
|
||||
### Style
|
||||
|
||||
<!-- Changes that affect Black's style -->
|
||||
|
||||
### _Blackd_
|
||||
|
||||
<!-- Changes to blackd -->
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- Changes to how Black can be configured -->
|
||||
|
||||
- Do not format `__pypackages__` directories by default (#2836)
|
||||
- Add support for specifying stable version with `--required-version` (#2832).
|
||||
|
||||
### Documentation
|
||||
|
||||
<!-- Major changes to documentation and policies. Small docs changes
|
||||
don't need a changelog entry. -->
|
||||
|
||||
### Integrations
|
||||
|
||||
<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
|
||||
|
||||
### Output
|
||||
|
||||
<!-- Changes to Black's terminal output and error messages -->
|
||||
|
||||
### Packaging
|
||||
|
||||
<!-- Changes to how Black is packaged, such as dependency requirements -->
|
||||
|
||||
### Parser
|
||||
|
||||
<!-- Changes to the parser or to version autodetection -->
|
||||
|
||||
### Performance
|
||||
|
||||
<!-- Changes that improve Black's performance. -->
|
||||
|
||||
## 22.1.0
|
||||
|
||||
At long last, _Black_ is no longer a beta product! This is the first non-beta release
|
||||
|
@ -9,8 +9,10 @@ To cut a release, you must be a _Black_ maintainer with `GitHub Release` creatio
|
||||
access. Using this access, the release process is:
|
||||
|
||||
1. Cut a new PR editing `CHANGES.md` and the docs to version the latest changes
|
||||
1. Example PR: [#2616](https://github.com/psf/black/pull/2616)
|
||||
2. Example title: `Update CHANGES.md for XX.X release`
|
||||
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,56 @@ 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
|
||||
|
||||
<!-- Include any especially major or disruptive changes here -->
|
||||
|
||||
### Style
|
||||
|
||||
<!-- Changes that affect Black's style -->
|
||||
|
||||
### _Blackd_
|
||||
|
||||
<!-- Changes to blackd -->
|
||||
|
||||
### Configuration
|
||||
|
||||
<!-- Changes to how Black can be configured -->
|
||||
|
||||
### Documentation
|
||||
|
||||
<!-- Major changes to documentation and policies. Small docs changes
|
||||
don't need a changelog entry. -->
|
||||
|
||||
### Integrations
|
||||
|
||||
<!-- For example, Docker, GitHub Actions, pre-commit, editors -->
|
||||
|
||||
### Output
|
||||
|
||||
<!-- Changes to Black's terminal output and error messages -->
|
||||
|
||||
### Packaging
|
||||
|
||||
<!-- Changes to how Black is packaged, such as dependency requirements -->
|
||||
|
||||
### Parser
|
||||
|
||||
<!-- Changes to the parser or to version autodetection -->
|
||||
|
||||
### Performance
|
||||
|
||||
<!-- Changes that improve Black's performance. -->
|
||||
|
||||
```
|
||||
|
||||
## Release workflows
|
||||
|
||||
All _Blacks_'s automation workflows use GitHub Actions. All workflows are therefore
|
||||
|
Loading…
Reference in New Issue
Block a user