From ea5b2de2c85a96550878611b94115b6ddaf77139 Mon Sep 17 00:00:00 2001 From: GrantBirki Date: Wed, 1 Nov 2023 14:58:08 -0600 Subject: [PATCH] add 'Publishing a new release' to the docs --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 36dc136..9c349db 100644 --- a/README.md +++ b/README.md @@ -204,3 +204,17 @@ steps: id: output run: echo "${{ steps.test-action.outputs.time }}" ``` + +## Publishing a new release + +This project includes a helper script designed to streamline the process of tagging and pushing new releases for GitHub Actions. + +GitHub Actions allows users to select a specific version of the action to use, based on release tags. Our script simplifies this process by performing the following steps: + +1. **Retrieving the latest release tag:** The script starts by fetching the most recent release tag by looking at the local data available in your repository. + +1. **Prompting for a new release tag:** The user is then prompted to enter a new release tag. To assist with this, the script displays the latest release tag and provides a regex to validate the format of the new tag. + +1. **Tagging the new release:** Once a valid new tag is entered, the script tags the new release. + +1. **Pushing the new tag to the remote:** Finally, the script pushes the new tag to the remote repository. From here, you will need to create a new release in GitHub and users can easily reference the new tag in their workflows.