Not an issue - just suggestions concerning the README.md file from a first timer user.

[cdwensley]

Usage 1. perhaps add: "and commit these changes".

Usage 5. perhaps add: On the right you should see an elapsed time and a message "in progress".
When the process terminates, "in progress" changes to the timer taken.
If the process fails you will see a red cross on the left and receive an email with a link to the process log.
If the process succeeds ... ?? (has not happened for me yet).

page 3: The paragraph "It is recommended to create a separate YAML file ..." does not seem at all helpful.
(I may not be the only package author ignorant of such things.)
Surely you just need to advise the user to copy the file .github/workflows/release.yml from aclib or utils or ...,
(though it may well be the case that this already exists in all packages on GitHub?)

Minimal example: do not see the point of this for a first-time user.

Larger example: "The following example adds a boolean input dry-run ..." implies that this is not the standard example for making a release, although in fact it is.

[stertooy]

Thanks for the feedback!

I agree with all the suggestions on 'Usage', though I'd leave out the email bit, as this depends on user settings AFAIK.

Regarding the YAML file, I am wary of telling people to copy it from certain packages. The packaged in question may update their workflow to something non-standard, or they may not be able to update to the newest version of a particular action, and we'd have to keep things up-to-date in two different locations (which also fall under two different organisations on GitHub).

Rather, I'd propose the following:

1. We remove the minimal example and rephrase the larger example as "Template".
2. In the migration part, we change the text to something like

It is recommended to create a separate YAML file, e.g. release.yml, inside the .github/workflows/ folder of your package, containing a workflow that calls this action. Refer to the Template section below for what this file should contain.

3. We rephrase explanation of the inputs in the Example/Template section, and move the sentence

By setting the trigger to workflow_dispatch, you can then manually create a release from the "Actions" tab of your repository.

from the Migration section to the Example/Template section as well.

Does that sound good/better/useful/...?

[cdwensley]

Yes, that sound fine.

[fingolfin]

@cdwensley Thanks for the valuable feedback!

@stertooy your proposal sounds good to me!

[fingolfin]

I made PR #41 with some progress towards this, preview at https://github.com/gap-actions/release-pkg/blob/mh/README/README.md -- I did not (yet) update "usage step 5" but I hope it's already an improvement.