AUTHORS file is changed in GitHub Actions publish workflow
Closed this issue · 0 comments
This issue was opened after the facts, but in order to document the issue.
The publish workflow for release 1.17.1 was the first one to fail because the AUTHORS.md file was changed. This caused the work directory to be dirty, and in turn setuptools-scm calculated a development version number, which was rejected on Pypi. Actions Log file: https://github.com/zhmcclient/python-zhmcclient/actions/runs/10452928272
This was then circumvented in PR #1622 by removing AUTHORS.md from the dependency list of the distribution archives. The root cause for the changed AUTHORS.md file was not understood at the time.
The issue reoccurred in the exporter project today, because the circumvention was not propagated to the other projects. This time, I did a more thorough analysis and found the root cause to be that the git shortlog --summary --email
command does not show any authors anymore, when run in GitHub Actions. It does show authors when run locally on macOS.
PR #1694 provided a better circumvention by making the commands in the make target for AUTHORS.md check for whether the command returns authors, and if not, the original AUTHORS.md file is left unchanged and a warning is displayed.
The issue has been reported in GitHub ticket https://support.github.com/ticket/personal/0/3042554 (probably only visible by me).
Finally, PR #1702 added AUTHORS.md to the build dependencies again, because the better circumvention is now in place, and that allows to see in the log files whether the git command works again at some point.
All these changes have been rolled back into 1.18.1.