Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document git shortlog issue in Makefile #671

Merged
merged 1 commit into from
Oct 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -470,14 +470,16 @@ docker: $(done_dir)/docker_$(pymn)_$(PACKAGE_LEVEL).done
authors: AUTHORS.md
@echo "Makefile: $@ done."

# Make sure the AUTHORS.md file is up to date but has the old date when it did not change to prevent redoing dependent targets
# Make sure the AUTHORS.md file is up to date but has the old date when it did
# not change to prevent redoing dependent targets. In GitHub Actions, the
# 'git shortlog' command does not return authors anymore since around 8/2024.
# This is tolerated by leaving the file unchanged.
AUTHORS.md: _always
echo "# Authors of this project" >AUTHORS.md.tmp
echo "" >>AUTHORS.md.tmp
echo "Sorted list of authors derived from git commit history:" >>AUTHORS.md.tmp
echo '```' >>AUTHORS.md.tmp
sh -c "git shortlog --summary --email | cut -f 2 | sort >log.tmp"
sh -c "ls -l log.tmp"
sh -c "cat log.tmp >>AUTHORS.md.tmp"
echo '```' >>AUTHORS.md.tmp
sh -c "if ! grep -q '[^[:space:]]' log.tmp; then echo 'Warning - git shortlog does not display any authors - leaving AUTHORS.md file unchanged'; else if ! diff -q AUTHORS.md.tmp AUTHORS.md; then echo 'Updating AUTHORS.md as follows:'; diff AUTHORS.md.tmp AUTHORS.md; mv AUTHORS.md.tmp AUTHORS.md; else echo 'AUTHORS.md was already up to date'; fi; fi"
Expand Down