github-actions is a collection of end-user GitHub Actions that integrate with Cloud Native Buildpacks projects.
The buildpack/compute-metadata action parses a buildpack.toml and exposes the contents of the [buildpack] block as output parameters.
uses: docker://ghcr.io/buildpacks/actions/buildpack/compute-metadata| Parameter | Description |
|---|---|
path | Optional path to buildpack.toml. Defaults to <working-dir>/buildpack.toml |
| Parameter | Description |
|---|---|
id | The contents of buildpack.id |
name | The contents of buildpack.name |
version | The contents of buildpack.version |
homepage | The contents of buildpack.homepage |
The buildpackage/verify-metadata action parses the metadata on a buildpackage and verifies that the id and version match expected values.
uses: docker://ghcr.io/buildpacks/actions/buildpackage/verify-metadata with: id: test-buildpack version: "1.0.0" address: ghcr.io/example/test-buildpack@sha256:04ba2d17480910bd340f0305d846b007148dafd64bc6fc2626870c174b7c7de7| Parameter | Description |
|---|---|
id | The expected id for the buildpackage |
version | The expected version for the buildpackage |
address | The digest-style address of the buildpackage to verify |
The registry/add-entry adds an entry to the Buildpack Registry Index.
uses: docker://ghcr.io/buildpacks/actions/registry/add-entry with: token: ${{ secrets.BOT_TOKEN }} owner: ${{ env.INDEX_OWNER }} repository: ${{ env.INDEX_REPOSITORY }} namespace: ${{ steps.metadata.outputs.namespace }} name: ${{ steps.metadata.outputs.name }} version: ${{ steps.metadata.outputs.version }} address: ${{ steps.metadata.outputs.address }}| Parameter | Description |
|---|---|
token | A GitHub token with permissions to commit to the registry index repository. |
owner | The owner name of the registry index repository. |
repository | The repository name of the registry index repository. |
namespace | The namespace of the buildpack to register. |
name | The name of the buildpack to register. |
version | The version of the buildpack to register. |
address | The address of the buildpack to register. |
The registry/compute-metadata action parses a buildpacks/registry-index issue and exposes the contents as output parameters.
uses: docker://ghcr.io/buildpacks/actions/registry/compute-metadata with: issue: ${{ toJSON(github.events.issue) }}| Parameter | Description |
|---|---|
issue | The GitHub issue payload. |
| Parameter | Description |
|---|---|
id | The contents of id |
version | The contents of version |
address | The contents of addr |
namespace | The namespace portion of id |
name | The name portion of id |
The registry/request-add-entry action adds an entry to the Buildpack Registry Index.
uses: docker://ghcr.io/buildpacks/actions/registry/request-add-entry with: token: ${{ secrets.IMPLEMENTATION_PAT }} id: $buildpacksio/test-buildpack version: ${{ steps.deploy.outputs.version }} address: index.docker.io/buildpacksio/test-buildpack@${{ steps.deploy.outputs.digest }}| Parameter | Description |
|---|---|
token | A GitHub token with public_repo scope to open an issue against buildpacks/registry-index. |
id | A buildpack id that your user is allowed to manage. This is must be in {namespace}/{name} format. |
version | The version of the buildpack that is being added to the registry. |
address | The Docker URI of the buildpack artifact. This is must be in {host}/{repo}@{digest} form. |
The registry/request-yank-entry action yanks an entry from the Buildpack Registry Index.
uses: docker://ghcr.io/buildpacks/actions/registry/request-yank-entry with: token: ${{ secrets.IMPLEMENTATION_PAT }} id: buildpacksio/test-buildpack version: ${{ steps.deploy.outputs.version }}| Parameter | Description |
|---|---|
token | A GitHub token with public_repo scope to open an issue against buildpacks/registry-index. |
id | A buildpack id that your user is allowed to manage. This is must be in {namespace}/{name} format. |
version | The version of the buildpack that is being added to the registry. |
The registry/verify-namespace-owner action verifies that a user is an owner of a namespace in the Buildpack Registry Index.
uses: docker://ghcr.io/buildpacks/actions/registry/verify-namespace-owner with: token: ${{ secrets.BOT_TOKEN }} owner: ${{ env.NAMESPACES_OWNER }} repository: ${{ env.NAMESPACES_REPOSITORY }} namespace: ${{ steps.metadata.outputs.namespace }} user: ${{ toJSON(github.event.issue.user) }} add-if-missing: true| Parameter | Description |
|---|---|
token | A GitHub token with permissions to commit to the registry namespaces repository. |
owner | The owner name of the registry namespaces repository. |
repository | The repository name of the registry namespaces repository. |
namespace | The namespace to check ownership for. |
user | The Github user payload. |
add-if-missing | Whether to add the current user as the owner of the namespace if that namespace does not exist. (Optional. Default false) |
The registry/yank-entry action yanks an entry from the Buildpack Registry Index.
uses: docker://ghcr.io/buildpacks/actions/registry/yank-entry with: token: ${{ secrets.BOT_TOKEN }} owner: ${{ env.INDEX_OWNER }} repository: ${{ env.INDEX_REPOSITORY }} namespace: ${{ steps.metadata.outputs.namespace }} name: ${{ steps.metadata.outputs.name }} version: ${{ steps.metadata.outputs.version }}| Parameter | Description |
|---|---|
token | A GitHub token with permissions to commit to the registry index repository. |
owner | The owner name of the registry index repository. |
repository | The repository name of the registry index repository. |
namespace | The namespace of the buildpack to register. |
name | The name of the buildpack to register. |
version | The version of the buildpack to register. |
The setup-pack action adds pack to the environment.
uses: buildpacks/github-actions/setup-pack@v5.0.0| Parameter | Description |
|---|---|
pack-version | Optional version of pack to install. Defaults to latest release. |
The setup-tools action adds crane and yj to the environment.
uses: buildpacks/github-actions/setup-tools@v5.0.0| Parameter | Description |
|---|---|
crane-version | Optional version of crane to install. Defaults to 0.12.1. |
yj-version | Optional version of yj to install. Defaults to 5.1.0. |
This library is released under version 2.0 of the Apache License.
