diff --git a/README.md b/README.md index 66afd2b..41876cf 100644 --- a/README.md +++ b/README.md @@ -4,18 +4,18 @@ Add following step to your workflow: ```yaml -- uses: dev-drprasad/delete-tag-and-release@v1.0 # PRERELEASE is v1.0 and can also be used to test and give us feedback +- uses: dev-drprasad/delete-tag-and-release@v1.2 with: - tag_name: v0.1.0 #(required) tag name to delete - github_token: ${{ secrets.GITHUB_TOKEN }} # (required) a GitHub token with write access to the repo that needs to be modified - delete_release: true #(optional) default: true - repo: / #(optional) target repository. default: repo running this action + tag_name: v0.1.2 #(required) - The name of the tag to delete. This is expected to be solely the tag name, not the name of a git reference. + delete_release: true #(optional) default: true - also delete releases and their assets that are associated to the tag name + repo: / #(optional) default: repo running this action - the target repository. + github_token: ${{ secrets.GITHUB_TOKEN }} # (required) - a GitHub token with write access to the repo that needs to be modified ``` ## Developing You can follow these instructions to get this project cloned to your local machine and ready for development. Note that -development requires at least [Node 16](https://nodejs.org/en/download) to be installed on your computer. +development requires at least [Node 20](https://nodejs.org/en/download) to be installed on your computer. ```shell git clone https://github.com/dev-drprasad/delete-tag-and-release.git