Github action to run release packages against a repository, this provides release creation with the following features;
- List multiple assets and directores for auto-archiving
- Auto increment semver (with pattern matching on existing release naming)
- Mark as pre-release
- Dry run without release (for testing releases via non-release branches)
- Fetch the latest release tag for an asset
To use this action, define it in your workflow;
on: [push, pull_request]
jobs:
lint:
runs-on: self-hosted
name: Lint package
steps:
- uses: actions/checkout@v2
- uses: qernal/github-actions-release@v1.0.8| Parameter | Description | Default | Required | Values |
|---|---|---|---|---|
tag |
Tag to use, can be initial tag if tag_pattern is set |
no default | Y | String |
tag_pattern |
A regular expression of the pattern to use, e.g. abc_v(?P<semver>([0-9]+)\.([0-9]+)\.([0-9]+)) - the pattern must include a semver group that matches a semantic versioning pattern otherwise the replacement will fail |
no default | N | String |
release_name |
Name of the release | no default | N | String |
release_description |
Description of the release | no default | N | String |
prerelease |
Mark as prerelease | false | N | boolean |
assets |
Comma separated list of assets, can be files or directory | no default | Y | String, e.g. file.yaml,file2.yaml,charts |
auto_increment |
Auto increment | no default | N | String, values are; major, minor, patch |
repo_name |
Name of the repository to create release on | Y | String | |
token |
GitHub PAT Token to access/create release | no default | Y | String |
dry_run |
not yet implemented | False | N | Boolean |
get_last_tag |
Gets the last tag that was created, doesn't create or update the release - this is for information | False | N | Boolean |
Example;
steps:
- uses: actions/checkout@v2
- uses: qernal/github-actions-rust-release@v1.0.8
with:
tag: "abc_v1.0.0"
tag_pattern: 'abc_v(?P<semver>([0-9]+)\.([0-9]+)\.([0-9]+))'
token: "${{ secrets.github_token }}"| Output | Description |
|---|---|
tag |
Tag that was created or acquired during the release |
You can use the container without the context of the runner, and just run the container like so;
docker run --rm -v `pwd`:/github/workspace ghcr.io/qernal/gh-actions/release-x86_64:mainReplace the pwd with your workspace if you're not running from the current directory
INPUT_TAG="abc_v1.0.0" INPUT_TAG_PATTERN="abc_v(?P<semver>([0-9]+)\.([0-9]+)\.([0-9]+))" INPUT_ASSETS="./example-assets" INPUT_AUTO_INCREMENT="minor" INPUT_REPO_NAME="my-user/releases-repo" INPUT_TOKEN="xxxx" python3 ./src/release.py