https://github.com/gembaadvantage/uplift-action
:octocat: Github action for Uplift the semantic versioning tool
https://github.com/gembaadvantage/uplift-action
action actions conventional-commits github github-action go golang semantic-versioning uplift
Last synced: 5 months ago
JSON representation
:octocat: Github action for Uplift the semantic versioning tool
- Host: GitHub
- URL: https://github.com/gembaadvantage/uplift-action
- Owner: gembaadvantage
- License: mit
- Created: 2021-04-09T19:31:31.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-10-14T20:01:35.000Z (8 months ago)
- Last Synced: 2025-10-26T07:38:50.037Z (8 months ago)
- Topics: action, actions, conventional-commits, github, github-action, go, golang, semantic-versioning, uplift
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/uplift-action
- Size: 418 KB
- Stars: 1
- Watchers: 0
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Uplift Github Action
[](https://github.com/gembaadvantage/uplift-action/actions?workflow=ci)
[](/LICENSE)
[](https://codecov.io/gh/gembaadvantage/uplift-action)
A Github Action for the [Uplift](https://github.com/gembaadvantage/uplift) semantic versioning tool.
## Basic Usage
Easily integrate uplift into your existing workflows, by using `v2` of the action:
```yaml
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: gembaadvantage/uplift-action@v2
with:
args: release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
## Triggering another Workflow
If you need uplift to trigger another workflow after it has tagged your repository, you will need to associate a custom personal access token with the `GITHUB_TOKEN`. This is by [design](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow).
```yaml
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GH_UPLIFT }}
- uses: gembaadvantage/uplift-action@v2
with:
args: release
env:
GITHUB_TOKEN: ${{ secrets.GH_UPLIFT }}
```
## Customising the Git Author
By default, uplift will interact with git as the [uplift-bot](https://github.com/uplift-bot). To configure this behaviour, you have two options:
1. Set the git author directly through uplift [configuration](https://upliftci.dev/reference/config/#commitauthor):
```yaml
# .uplift.yaml
commitAuthor:
name: 'joe.bloggs'
email: 'joe.bloggs@gmail.com'
```
1. [Import](https://upliftci.dev/commit-signing/) a GPG key (_recommended_):
```yaml
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
token: ${{ secrets.GH_UPLIFT }}
- uses: gembaadvantage/uplift-action@v2
with:
args: release
env:
GITHUB_TOKEN: ${{ secrets.GH_UPLIFT }}
UPLIFT_GPG_KEY: "${{ secrets.UPLIFT_GPG_KEY }}"
UPLIFT_GPG_PASSPHRASE: "${{ secrets .UPLIFT_GPG_PASSPHRASE }}"
UPLIFT_GPG_FINGERPRINT: "${{ secrets.UPLIFT_GPG_FINGERPRINT }}"
```
### Inputs
Customisable inputs can be provided through the `with` keys:
| Name | Required | Type | Default | Description |
| -------------- | -------- | ------- | -------- | -------------------------------------------------------------------------------------- |
| `version` | No | String | `latest` | The uplift version, see [available](https://github.com/gembaadvantage/uplift/releases) |
| `install-only` | No | Boolean | `false` | Set to true to install uplift and expose the binary on the current PATH |
| `args` | Yes | String | | A list of arguments that are used when running Uplift |