diff --git a/README.md b/README.md index 46e25bc..a9c9da3 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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" 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 @@ -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