Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rickstaa/action-create-tag
Simple GitHub action that can be used to create a tag inside a GitHub action.
https://github.com/rickstaa/action-create-tag
docker gh-action github-action-docker github-actions tagging utilities
Last synced: 9 days ago
JSON representation
Simple GitHub action that can be used to create a tag inside a GitHub action.
- Host: GitHub
- URL: https://github.com/rickstaa/action-create-tag
- Owner: rickstaa
- License: mit
- Created: 2021-01-11T21:17:04.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-23T17:10:00.000Z (6 months ago)
- Last Synced: 2024-09-20T22:03:50.292Z (about 2 months ago)
- Topics: docker, gh-action, github-action-docker, github-actions, tagging, utilities
- Language: Shell
- Homepage: https://github.com/marketplace/actions/create-update-tag
- Size: 73.2 KB
- Stars: 72
- Watchers: 2
- Forks: 32
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Action: Create/update tag
[](https://github.com/rickstaa/action-create-tag/actions)
[](https://github.com/rickstaa/action-create-tag/actions?query=workflow%3A%22Code+quality+CI%22)
[](https://github.com/rickstaa/action-create-tag/actions?query=workflow%3Arelease)
[](https://github.com/rickstaa/action-create-tag/releases)
Simple (docker-based) GitHub action that can be used to create/update a tag and push it to the remote.
> [!NOTE]\
> Since this is a docker-based action and [GitHub currently only supports Linux-based containers](https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action) running this action on Windows and Mac now needs to be supported (see [#26](https://github.com/rickstaa/action-create-tag/issues/26)).
## Inputs
### `tag`
**Required**. Tag you want to create.
### `message`
**Optional**. Tag message. Default: `Release $TAG`.
### `force_push_tag`
**Optional**. Push tag even if it already exists on the remote. Default: `false`. Please use with care!
### `tag_exists_error`
**Optional**. Whether to throw an error when the tag already exists. Default: `true`. Ignored when `force_push_tag` is `true`.
### `no_verify_tag`
**Optional**. Skips verifying when pushing the tag. Default: `false`. Please use with care!
### `commit_sha`
**Optional**. Specify the commit SHA hash for tagging. By default, it utilizes the `GITHUB_SHA` environment variable, which typically represents the latest commit SHA hash. However, its value ultimately depends on the trigger event of the workflow. For additional details, consult the [GitHub Actions documentation](https://docs.github.com/en/actions/reference/context-and-expression-syntax-for-github-actions#github-context).
### `github_token`
**Optional**. It's no need to specify it if you use checkout@v2. Required for
checkout@v1 action.
### `gpg_private_key`
**Optional**. Specifies the GPG private key to sign the tag with. Default: `""`.
### `gpg_passphrase`
**Optional**. Specifies the GPG passphrase to sign the tag with. Default: `""`.
## Outputs
### `tag_exists`
A boolean specifying whether the tag already exists.
## Environment variables
### `TAG_EXISTS`
A boolean specifying whether the tag already exists.
## Example Usage
### General example
```yml
name: Create/update tag
on:
push:
branch: "main"
jobs:
create-tag:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: rickstaa/action-create-tag@v1
id: "tag_create"
with:
tag: "latest"
tag_exists_error: false
message: "Latest release"
# Print result using the env variable.
- run: |
echo "Tag already present: ${{ env.TAG_EXISTS }}"
# Print result using the action output.
- run: |
echo "Tag already present: ${{ steps.tag_create.outputs.tag_exists }}"
```
### Signing Tags with GPG
To sign tags with GPG, follow these steps:
#### 1. Generate a GPG Key
First, [generate a GPG key](https://docs.github.com/en/github/authenticating-to-github/generating-a-new-gpg-key). Once generated, export the GPG private key in ASCII armored format to your clipboard using one of the following commands based on your operating system:
- **macOS:**
```shell
gpg --armor --export-secret-key [email protected] | pbcopy
```
- **Ubuntu (GNU base64):**
```shell
gpg --armor --export-secret-key [email protected] -w0 | xclip -selection clipboard
```
- **Arch:**
```shell
gpg --armor --export-secret-key [email protected] | xclip -selection clipboard -i
```
- **FreeBSD (BSD base64):**
```shell
gpg --armor --export-s[.github/workflows/update_semver.yml](.github/workflows/update_semver.yml)e your GPG passphrase.
```
#### 3. Update Workflow YAML
Modify your workflow YAML file to include the GPG private key and passphrase in the `gpg_private_key` and `gpg_passphrase` inputs:
```yaml
name: Create/update tag
on:
push:
branch: "main"
jobs:
create-tag:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: rickstaa/action-create-tag@v1
id: "tag_create"
with:
tag: "latest"
tag_exists_error: false
message: "Latest release"
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
gpg_passphrase: ${{ secrets.PASSPHRASE }}
# Print result using the env variable.
- run: |
echo "Tag already present: ${{ env.TAG_EXISTS }}"
# Print result using the action output.
- run: |
echo "Tag already present: ${{ steps.tag_create.outputs.tag_exists }}"
```
This workflow will now sign tags using the specified GPG key during tag creation.
## Contributing
Feel free to open an issue if you have ideas on how to make this GitHub action better or if you want to report a bug! All contributions are welcome. :rocket: Please consult the [contribution guidelines](CONTRIBUTING.md) for more information.