Skip to content

Small README updates #44

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
fingolfin merged 3 commits into from
Nov 4, 2025
Merged

Small README updates #44

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a75a294
Fix reference nr 3
stertooy Oct 31, 2025
2a7114a
Update README.md
stertooy Oct 31, 2025
2af5998
Update README.md
stertooy Nov 4, 2025
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
13 changes: 10 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,13 @@ these steps:
If everything is configured right, the new release of your package should
appear on GitHub and your package's website within a few minutes.

> [!CAUTION]
> We recommend a 'dry run' the first time you use this workflow.
> This will create an archive containing the release, which can be downloaded under
> the `Artifacts` in the relevant run of this workflow, but not actually publish the
> release. You can then inspect the release archive and, if satisfactory, re-run this
> workflow without the 'dry run' option.


## Initial setup

Expand Down Expand Up @@ -59,12 +66,12 @@ on:
workflow_dispatch:
inputs:
dry-run:
description: "Only create an archive containing the release instead of publishing it on GitHub"
description: "Dry run: only create an archive containing the release instead of publishing it on GitHub"
Copy link
Member

@fingolfin fingolfin Nov 4, 2025

Choose a reason for hiding this comment

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

Fine by me, but then we should consider applying the same change to all release.yml files using the old phrasing, just to avoid them deviating too much from each other over time...

(I have a script which can do that, so it's no biggie, I just don't want to forget it)

type: boolean
required: false
default: false
force:
description: "Allow overwriting an existing release, or making a release with an incorrect date"
description: "Force: allow overwriting an existing release, or making a release with an incorrect date"
type: boolean
required: false
default: false
Expand Down Expand Up @@ -188,4 +195,4 @@ with this action or the FSF's own site.

[1]: https://github.com/gap-system/ReleaseTools
[2]: https://github.com/gap-actions/update-gh-pages
[2]: https://github.com/gap-actions/build-pkg-docs
[3]: https://github.com/gap-actions/build-pkg-docs