From 53a6216cd57955837e84f6ea82ca650c86320b03 Mon Sep 17 00:00:00 2001 From: Cooper Lees Date: Thu, 1 Apr 2021 09:54:45 -0700 Subject: [PATCH] Add CONTRBUTING info about CHANGES.md requirement (#2073) Instruct contributors to add the change line to help save maintainer / releaser time --- .github/workflows/changelog.yml | 4 ++-- CONTRIBUTING.md | 17 +++++++++++++++++ 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/.github/workflows/changelog.yml b/.github/workflows/changelog.yml index 58a8c09..d7ee505 100644 --- a/.github/workflows/changelog.yml +++ b/.github/workflows/changelog.yml @@ -16,6 +16,6 @@ jobs: - name: Grep CHANGES.md for PR number if: contains(github.event.pull_request.labels.*.name, 'skip news') != true run: | - grep -Pz "PR( |\n\s*)#${{ github.event.pull_request.number }}[^0-9]" CHANGES.md || \ - (echo "Please add 'PR #${{ github.event.pull_request.number }}' change line to CHANGES.md" && \ + grep -Pz "\((\n\s*)?#${{ github.event.pull_request.number }}(\n\s*)?\)" CHANGES.md || \ + (echo "Please add '(#${{ github.event.pull_request.number }})' change line to CHANGES.md" && \ exit 1) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 571d870..8a3d8bf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,6 +58,23 @@ $ tox -e fuzz $ 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, checkout the latest issue and PR number and add 1. 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. + +_Suggestions welcome on how this could be a better less invasive flow._ + ### Docs Testing If you make changes to docs, you can test they still build locally too. -- 2.39.5