]> git.madduck.net Git - etc/vim.git/commitdiff

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

Add CONTRBUTING info about CHANGES.md requirement (#2073)
authorCooper Lees <me@cooperlees.com>
Thu, 1 Apr 2021 16:54:45 +0000 (09:54 -0700)
committerGitHub <noreply@github.com>
Thu, 1 Apr 2021 16:54:45 +0000 (18:54 +0200)
Instruct contributors to add the change line to help save maintainer / releaser time

.github/workflows/changelog.yml
CONTRIBUTING.md

index 58a8c092edb7762ad680ae332513ccba8cef87ff..d7ee50558d3655e5f02b6668f162cb90777d8073 100644 (file)
@@ -16,6 +16,6 @@ jobs:
       - name: Grep CHANGES.md for PR number
         if: contains(github.event.pull_request.labels.*.name, 'skip news') != true
         run: |
       - 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)
           exit 1)
index 571d870452bc4c6f36473d26026b5da83c915b95..8a3d8bf2830e45ac2fe6304330bf80a6207e008f 100644 (file)
@@ -58,6 +58,23 @@ $ 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, 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.
 ### Docs Testing
 
 If you make changes to docs, you can test they still build locally too.