Skip to content

Latest commit

 

History

History
89 lines (71 loc) · 8.47 KB

README.md

File metadata and controls

89 lines (71 loc) · 8.47 KB

branding<icon:package color:gray-dark> GitHub Action: Create images manifests

Release%20by%20tagRelease%20by%20dateCommitOpen%20IssuesDownloads

Action to create built images manifests

If default GitHub token is used, the following permissions are required:

permissions:
  contents: read
  packages: write
- uses: hoverkraft-tech/[email protected]
  with:
    # Description: OCI registry where to pull and push images
    #
    # Default: ghcr.io
    oci-registry: ""

    # Description: Username used to log against the OCI registry. See
    # <https://github.com/docker/login-action#usage>
    #
    # Default: ${{ github.repository_owner }}
    oci-registry-username: ""

    # Description: Password or personal access token used to log against the OCI
    # registry. Can be passed in using "secrets.GITHUB_TOKEN". See
    # <https://github.com/docker/login-action#usage>.
    #
    # Default: ${{ github.token }}
    oci-registry-password: ""

    # Description: Built images data. Example: { "application": { "name":
    # "application", "registry": "ghcr.io", "repository":
    # "my-org/my-repo/application", "tags": ["pr-63-5222075","pr-63"], "images": [
    # "ghcr.io/my-org/my-repo/application:pr-63-5222075",
    # "ghcr.io/my-org/my-repo/application:pr-63" ], "digests": [
    # "ghcr.io/my-org/my-repo/application@sha256:d31aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f49d",
    # "ghcr.io/my-org/my-repo/application@sha256:0f5aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f402"
    # ], "annotations": { "org.opencontainers.image.created": "2021-09-30T14:00:00Z",
    # "org.opencontainers.image.description": "Application image" } } }
    #
    built-images: ""
Input Description Default Required
oci-registry OCI registry where to pull and push images ghcr.io true
oci-registry-username Username used to log against the OCI registry. See https://github.com/docker/login-action#usage ${{ github.repository_owner }} true
oci-registry-password Password or personal access token used to log against the OCI registry.
Can be passed in using "secrets.GITHUB_TOKEN".
See https://github.com/docker/login-action#usage.		 ${{ github.token }} true
built-images Built images data. Example: { "application": { "name": "application", "registry": "ghcr.io", "repository": "my-org/my-repo/application", "tags": ["pr-63-5222075","pr-63"], "images": [ "ghcr.io/my-org/my-repo/application:pr-63-5222075", "ghcr.io/my-org/my-repo/application:pr-63" ], "digests": [ "ghcr.io/my-org/my-repo/application@sha256:d31aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f49d", "ghcr.io/my-org/my-repo/application@sha256:0f5aa93410434ac9dcfc9179cac2cb1fd4d7c27f11527addc40299c7c675f402" ], "annotations": { "org.opencontainers.image.created": "2021-09-30T14:00:00Z", "org.opencontainers.image.description": "Application image" } } } true
Output Description Default Required
images The images tags built. Example: ["ghcr.io/my-org/my-repo/application:pr-63-linux-amd64","ghcr.io/my-org/my-repo/application:pr-63-5222075-linux-amd64"] undefined undefined
tag-suffix The platform tag suffix. Example: "-linux-amd64" undefined undefined