GitHub release change log automation munges information
https://github.com/caketop/python-starlark-go/releases/tag/v1.0.1rc1 and the release before it both have spurious URL escaped new lines in plain text.
I speculate that there's something about how the generated changelog is getting marshaled into the GH release body.
Currently, the generated changelog is passed as a string to the GH release body.
https://github.com/caketop/python-starlark-go/blob/9573ece2660b8dfc04daadd0d84d97fbf9b63808/.github/workflows/build_wheels.yml#L117-L132
I think it would be safer to configure the changelog generator to write a file with output and action-gh-release to read it in via its body_path.
-
action-gh-release docs
inputs: https://github.com/softprops/action-gh-release?tab=readme-ov-file#inputs -
action-github-changelog-generator docs
inputs: https://github.com/janheinrichmerker/action-github-changelog-generator?tab=readme-ov-file#inputs
Oh, action-gh-release has boolean input generate_release_notes, so maybe we can use that in place of the separate action. However, it seems to use GitHub's built-in release notes generator, which is not as inclusive as janheinrichmerker's.
Oddly, action-github-changelog-generator's own release.yml passes body: ${{ steps.generate-release-changelog.outputs.changelog }}... but it uses actions/create-release instead of softprops/action-gh-release. The former is unmaintained.
https://github.com/janheinrichmerker/action-github-changelog-generator/issues/44 is also documenting the issue and others have reported that 2.3 doesn't have the problem.. but 2.3 uses ::set-output which IIRC has been disabled. Using a file it is.
Fixed in 1.0.1 release.