Skip to content

Add a body-text input, for describing the GitHub release #25

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Sep 4, 2025
Merged

Add a body-text input, for describing the GitHub release #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ inputs:
description: "Set to true to allow this action to overwrite an existing release, and to make a release with an incorrect date"
required: false
default: "false"
body-text:
description: "Body text for the new GitHub release that will appear on the package's GitHub Releases page"
required: false
default: "Release of ${{ github.event.repository.name }}"
Copy link
Member

@fingolfin fingolfin Sep 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to double check: did you verify this works? I.e. inserts the correct name.

That said, I wonder if we should not simply default to an empty string. Looking at https://github.com/gap-packages/aclib/releases/tag/v1.3.3 the "Release for AClib" in there doesn't really add any useful information. I know it's taken from classic ReleaseTools...

Anyway I modified an older release to have an empty body, turns out GitHub will then show some filler information that's not great either -- looks to me like the tag name and the commit message of the commit to which the tag is pointing?

Entering just a space as body doesn't help, it seems leading and trailing spaces are removed. I can use a non-breaking space entity   to get this look.

So maybe "Release of BLA" is fine after all ...

Thanks for listening in to my random brain musings, tune in again tomorrow when we ask more weird off-topic questions

Copy link
Contributor Author

@wilfwilson wilfwilson Sep 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I agree with your sentiment here, the "Release for/of Package" doesn't really add anything. But if having the body be blank is not really possible, then I'm happy to keep the default as "Release for/of Package" instead.

It can always be changed in a future pull request anyway, I'm certainly not attached to it!


runs:
using: "composite"
Expand Down Expand Up @@ -167,8 +171,8 @@ runs:
uses: softprops/action-gh-release@v2
if: ${{ inputs.dry-run == 'false' }}
with:
body: "Release for ${{ env.PKGNAME }}"
name: "${{ env.PKGNAME }} ${{ env.VERSION }}"
body: "${{ inputs.body-text }}"
fail_on_unmatched_files: true
tag_name: "${{ env.TAG }}"
files: ${{ env.ASSETS }}/*
Expand Down