From 1dee4d9d38977afcacbe4fc6476cefebd335f678 Mon Sep 17 00:00:00 2001 From: nodiscc Date: Sat, 15 Jul 2023 19:01:18 +0200 Subject: [PATCH] tools/authors: use plaintext instead of markdown for the authors file - move the authors file to AUTHORS as recommended by https://www.gnu.org/prep/maintain/html_node/Recording-Contributors.html - simplifies tooling and reduces the risk of invalid markdown injection from a contributor's email address/name --- AUTHORS.md => AUTHORS | 0 Makefile | 4 ++-- README.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) rename AUTHORS.md => AUTHORS (100%) diff --git a/AUTHORS.md b/AUTHORS similarity index 100% rename from AUTHORS.md rename to AUTHORS diff --git a/Makefile b/Makefile index 17ed56cb..9c8a08d0 100755 --- a/Makefile +++ b/Makefile @@ -1,5 +1,5 @@ #!/usr/bin/make -f SHELL = /bin/bash -# update the AUTHORS.md file +# update the AUTHORS file contrib: - @mv .github/.mailmap . && printf "|Commits | Author |\n| :---: | --- |\n" > AUTHORS.md && git shortlog -sne | sed -r 's/^\s*([[:digit:]]*?)\s*?(.*?)/|\1|\2|/' >> AUTHORS.md && mv .mailmap .github/.mailmap + @mv .github/.mailmap . && printf "Commits|Author\n-------|---------------------------------------------------\n" > AUTHORS && git shortlog -sne >> AUTHORS && mv .mailmap .github/.mailmap diff --git a/README.md b/README.md index 9b926f2f..74b4a660 100644 --- a/README.md +++ b/README.md @@ -2189,7 +2189,7 @@ Contributing guidelines can be found in [.github/CONTRIBUTING.md](.github/CONTRI ## Authors -The list of authors can be found in [AUTHORS.md](AUTHORS.md). +The list of authors can be found in the [AUTHORS](AUTHORS) file. ## License