actions/black
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Push contributors to use Next PR Number (#2080)

Browse Source 
This is a tool of my own making. Right now our requirement to have the
PR number in the changelog entry is pretty painful / annoying since
the contributor either has to guess or add the # retroactively after
the PR creation. This tool should make it way less painful by making
it simple to get your PR number beforehand.
This commit is contained in:
Richard Si 2021-04-01 17:24:18 -04:00 committed by GitHub
parent 53a6216cd5
commit 48dfda084a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
CONTRIBUTING.md
View File

@ -69,11 +69,10 @@ have a line in the following format:
- `Black` is now more awesome (#X) - `Black` is now more awesome (#X)
``` ```
To workout X, checkout the latest issue and PR number and add 1. This is not perfect but To workout X, please use
saves a lot of release overhead as now the releaser does not need to go back and workout [Next PR Number](https://ichard26.github.io/next-pr-number/?owner=psf&name=black). This
what to add to the `CHANGES.md` for each release. is not perfect but saves a lot of release overhead as now the releaser does not need to
go back and workout what to add to the `CHANGES.md` for each release.
_Suggestions welcome on how this could be a better less invasive flow._
### Docs Testing ### Docs Testing

16
docs/contributing_to_black.md
View File

@ -60,6 +60,22 @@ $ tox -e fuzz
$ black-primer [-k -w /tmp/black_test_repos] $ black-primer [-k -w /tmp/black_test_repos]
``` ```
### News / Changelog Requirement
`Black` has CI that will check for an entry corresponding to your PR in `CHANGES.md`. If
you feel this PR not require a changelog entry please state that in a comment and a
maintainer can add a `skip news` label to make the CI pass. Otherwise, please ensure you
have a line in the following format:
```md
- `Black` is now more awesome (#X)
```
To workout X, please use
[Next PR Number](https://ichard26.github.io/next-pr-number/?owner=psf&name=black). This
is not perfect but saves a lot of release overhead as now the releaser does not need to
go back and workout what to add to the `CHANGES.md` for each release.
### Docs Testing ### Docs Testing
If you make changes to docs, you can test they still build locally too. If you make changes to docs, you can test they still build locally too.