Add a body-text input, for describing the GitHub release #25
Conversation
| 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 }}" |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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!
fingolfin
left a comment
fingolfin
left a comment
There was a problem hiding this comment.
Looks good to me but it would be good if @wilfwilson could confirm that the default text works as intended?
|
I did run it with the default text once or twice when developing this, but I'll run it again later to double check. |
|
I'm running a test here https://github.com/wilfwilson/Digraphs/actions/runs/17459058025/job/49579283799 to show that the default text option works. When that job complete the corresponding release should appear at https://github.com/wilfwilson/Digraphs/releases |
|
Yep, good enough for me: 
I'll delete that release now, and merge this PR. |
3 participants
I've tested this quite a bit on my fork of the Digraphs package and it seems to work for my purposes (see digraphs/Digraphs#803).
I've changed the default text
Release for <PKG>toRelease of <PKG>, because that seems more grammatically correct to me.Closes #17.