This action was deprecated on 2023-09-08 and will no longer receive support or updates.
This action can be used to delete a GitHub Release by tag when one exists. If the release does not exist, the action will simply return.
This functionality is also in the im-open/create-release action. You may wish to use this standalone action if the release needs to be deleted before an action to create a new release or if you have a workflow that cleans up old releases.
| Parameter | Is Required | Description |
|---|---|---|
github-token |
true | A GitHub token with permission to delete releases. Generally ${{ secrets.GITHUB_TOKEN }}. |
release-tag |
true | The tag of the release to delete |
No outputs
on:
pull_request:
types: [opened, reopened, synchronize]
jobs:
create-prebuilt-artifacts-release:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Calculate next version
id: version
uses: im-open/git-version-lite@v2
with:
calculate-prerelease-version: true
branch-name: ${{ github.head_ref }}
# The release might already exist if you hit 're-run jobs' on a workflow run that already
# completed once. Creating a release when one already exists will fail, so delete it first.
- name: Delete release if it exists
# You may also reference just the major or major.minor version
uses: im-open/[email protected]
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
release-tag: ${{ steps.version.outputs.VERSION }}
- name: Create release
id: create_release
# You may also reference just the major or major.minor version
uses: im-open/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag-name: ${{ env.VERSION }}
release-name: ${{ env.VERSION }}
. . .When creating PRs, please review the following guidelines:
- The action code does not contain sensitive information.
- At least one of the commit messages contains the appropriate
+semver:keywords listed under Incrementing the Version for major and minor increments. - The action has been recompiled. See Recompiling Manually for details.
- The README.md has been updated with the latest version of the action. See Updating the README.md for details.
This repo uses git-version-lite in its workflows to examine commit messages to determine whether to perform a major, minor or patch increment on merge if source code changes have been made. The following table provides the fragment that should be included in a commit message to active different increment strategies.
| Increment Type | Commit Message Fragment |
|---|---|
| major | +semver:breaking |
| major | +semver:major |
| minor | +semver:feature |
| minor | +semver:minor |
| patch | default increment type, no comment needed |
The files and directories that are considered source code are listed in the files-with-code and dirs-with-code arguments in both the build-and-review-pr and increment-version-on-merge workflows.
If a PR contains source code changes, the README.md should be updated with the latest action version and the action should be recompiled. The build-and-review-pr workflow will ensure these steps are performed when they are required. The workflow will provide instructions for completing these steps if the PR Author does not initially complete them.
If a PR consists solely of non-source code changes like changes to the README.md or workflows under ./.github/workflows, version updates and recompiles do not need to be performed.
This command utilizes esbuild to bundle the action and its dependencies into a single file located in the dist folder. If changes are made to the action's source code, the action must be recompiled by running the following command:
# Installs dependencies and bundles the code
npm run buildIf changes are made to the action's source code, the usage examples section of this file should be updated with the next version of the action. Each instance of this action should be updated. This helps users know what the latest tag is without having to navigate to the Tags page of the repository. See Incrementing the Version for details on how to determine what the next version will be or consult the first workflow run for the PR which will also calculate the next version.
This project has adopted the im-open's Code of Conduct.
Copyright © 2023, Extend Health, LLC. Code released under the MIT license.