GitHub Action to release a Tekton Task.
The following snippet shows the usage example, please note the attributes permissions.contents
and permissions.packages
required to allow the action upload the release data.
on:
push:
tags:
- "*"
jobs:
release:
permissions:
# allows the action to create a new release
contents: write
# allows the action to upload relese artifacts
packages: write
steps:
- uses: openshift-pipelines/release-tektoncd-task@main
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
This action is meant to run when a new repository release is created, the action expects to find a draft release in order to upload the artifacts and generate the release notes accordingly.
Make sure the action only runs when a tag
is issued, as the example above shows, and a draft release is already created for the tag
. After the action is executed you can publish the release.
The environment variable GITHUB_TOKEN
shares the authorization needed to upload the release artifacts, please check the repository settings to allow payload upload accordingly.
Input | Required | Default | Description |
---|---|---|---|
bundle_tag_suffix |
false |
-bundle |
Tekton Task-Bundle OCI container-image tag suffix |
cli_version |
false |
latest |
Tekton CLI (tkn ) version |
helm_version |
false |
latest |
Helm CLI (helm ) version |
crane_version |
false |
latest |
go-containerregistry/crane version |
The action expects to find a Chart.yaml
file in the root of the repository, from this file it extracts the Chart name and version. The version must match the current Git tag, informed via GITHUB_REF_NAME
environment variable, set during action execution by default.
The release artifacts are described below, the GitHub organization is actor
and the repository is example
containing a Chart version 0.0.1
, please consider:
Artifact Name | Description |
---|---|
example-0.0.1.yaml |
Tekton Task resource |
oci://ghcr.io/actor/example:0.0.1-bundle |
Tekton Task-Bundle OCI container-image |
example-0.0.1.tgz |
Helm-Chart tarball |
oci://ghcr.io/actor/example:0.0.1 |
Helm-Chart OCI container-image |
The Tekton Task-Bundle container-image receives the input bundle_tag_suffix
to compose the final tag.
Release note are generated automatically, with the respective commands to copy-and-paste to rollout the release artifacts.