python-starlark-go icon indicating copy to clipboard operation
python-starlark-go copied to clipboard

GitHub release change log automation munges information

Open colindean opened this issue 2 months ago • 4 comments

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.

colindean avatar Nov 21 '25 05:11 colindean

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

colindean avatar Nov 21 '25 16:11 colindean

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.

colindean avatar Nov 21 '25 16:11 colindean

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.

colindean avatar Nov 22 '25 03:11 colindean

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.

colindean avatar Nov 22 '25 03:11 colindean

Fixed in 1.0.1 release.

colindean avatar Dec 10 '25 04:12 colindean