--- WARNING - This GitHub Action will no longer be maintained ---

The owner (dev-drprasad) and maintainer (thadguidry) do not see a need for continuing maintenance because the feature can now be handled directly with a line of code in your workflows with GitHub CLI delete release. This repo thus will soon be archived.

GitHub Action: Delete tag and release

Usage

Add following step to your workflow:

- uses: dev-drprasad/[email protected]
  with:
    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 all releases and their assets that are associated to the tag name
    repo: <owner>/<repoName> #(optional) default: repo running this action - the target repository. 
    github_token: ${{ secrets.GITHUB_TOKEN }} # (required) - a GitHub token with write access to the repo where tags and releases will be searched and deleted

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 20 to be installed on your computer.

git clone https://github.com/dev-drprasad/delete-tag-and-release.git
cd delete-tag-and-release
npm install

Tests can be run via:

npm test

Since this is a repo for a GitHub Action, every new commit that changes code must include a new bundle. You can generate a new bundle via running:

npm run package

and committing the resulting changes that will be in the dist/ folder.

Formatting and linting

This project uses ESLint for linting and Prettier for source code formatting. You can run the lint checks by running:

npm run lint

If you have lint errors that are automatically fixable, you can fix those by running:

npm run lint:fix

Releasing

Releases are done by creating a new tag and pushing that tag to the repo. A new release can be made via the following:

git checkout master
git fetch
git pull
# choose either patch, minor, or major. See https://docs.npmjs.com/cli/v8/commands/npm-version#description for more info
npm version <patch/minor/major>
git push --follow-tags

This will update the version in the package.json, create a new commit based off of the master branch, and create a new Git tag with that version that points to the new commit. Remember to use the --follow-tags flag when running git push! Without it, the new tag won't be pushed.