Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/redhat-actions/push-to-registry

GitHub Action to push a container image to an image registry.
https://github.com/redhat-actions/push-to-registry

action cloud containers docker kubernetes openshift redhat

Last synced: 25 days ago
JSON representation

GitHub Action to push a container image to an image registry.

Awesome Lists containing this project

README 

        
# push-to-registry



[![CI checks](https://github.com/redhat-actions/push-to-registry/workflows/CI%20checks/badge.svg)](https://github.com/redhat-actions/push-to-registry/actions?query=workflow%3A%22CI+checks%22)

[![Link checker](https://github.com/redhat-actions/push-to-registry/workflows/Link%20checker/badge.svg)](https://github.com/redhat-actions/push-to-registry/actions?query=workflow%3A%22Link+checker%22)





[![Push to Quay.io](https://github.com/redhat-actions/push-to-registry/actions/workflows/quay-push.yaml/badge.svg)](https://github.com/redhat-actions/push-to-registry/actions/workflows/quay-push.yaml)

[![Push to GHCR](https://github.com/redhat-actions/push-to-registry/actions/workflows/ghcr-push.yaml/badge.svg)](https://github.com/redhat-actions/push-to-registry/actions/workflows/ghcr-push.yaml)

[![Login and Push](https://github.com/redhat-actions/push-to-registry/workflows/Login%20and%20Push/badge.svg)](https://github.com/redhat-actions/push-to-registry/actions?query=workflow%3A%22Login+and+Push%22)

[![Build and Push Manifest](https://github.com/redhat-actions/push-to-registry/actions/workflows/manifest-build-push.yaml/badge.svg)](https://github.com/redhat-actions/push-to-registry/actions/workflows/manifest-build-push.yaml)

[![Multiple container CLI build tests](https://github.com/redhat-actions/push-to-registry/workflows/Multiple%20container%20CLI%20build%20tests/badge.svg)](https://github.com/redhat-actions/push-to-registry/actions?query=workflow%3A%22Multiple+container+CLI+build+tests%22)





[![tag badge](https://img.shields.io/github/v/tag/redhat-actions/push-to-registry)](https://github.com/redhat-actions/push-to-registry/tags)

[![license badge](https://img.shields.io/github/license/redhat-actions/push-to-registry)](./LICENSE)

[![size badge](https://img.shields.io/github/size/redhat-actions/push-to-registry/dist/index.js)](./dist)



Push-to-registry is a GitHub Action for pushing a container image or an [image manifest](https://github.com/containers/buildah/blob/main/docs/buildah-manifest.1.md) to an image registry, such as Dockerhub, quay.io, the GitHub Container Registry, or an OpenShift integrated registry.



This action only runs on Linux, as it uses [podman](https://github.com/containers/Podman) to perform the push. [GitHub's Ubuntu action runners](https://github.com/actions/virtual-environments#available-environments) come with Podman preinstalled. If you are not using those runners, you must first [install Podman](https://podman.io/getting-started/installation).



You can log in to your container registry for the entire job using the [**podman-login**](https://github.com/redhat-actions/podman-login) action. Otherwise, use the `username` and `password` inputs to log in for this step.



## Action Inputs



Refer to the [`podman push`](http://docs.podman.io/en/latest/markdown/podman-manifest-push.1.html) documentation for more information.



| Input Name | Description | Default |

| ---------- | ----------- | ------- |

| image	| Name of the image or manifest you want to push. Eg. `username/imagename` or `imagename`. Refer to [Image and Tag Inputs](https://github.com/redhat-actions/push-to-registry#image-tag-inputs). | **Required** - unless all tags include registry and image name

| tags | The tag or tags of the image or manifest to push. For multiple tags, separate by whitespace. Refer to [Image and Tag Inputs](https://github.com/redhat-actions/push-to-registry#image-tag-inputs). | `latest`

| registry | Hostname and optional namespace to push the image to. Eg. `quay.io` or `quay.io/username`. Refer to [Image and Tag Inputs](https://github.com/redhat-actions/push-to-registry#image-tag-inputs). | **Required** - unless all tags include registry and image name

| username | Username with which to authenticate to the registry. Required unless already logged in to the registry. | None

| password | Password, encrypted password, or access token to use to log in to the registry. Required unless already logged in to the registry. | None

| tls-verify | Verify TLS certificates when contacting the registry. Set to `false` to skip certificate verification. | `true`

| digestfile | After copying the image, write the digest of the resulting image to the file. The contents of this file are the digest output. | Auto-generated from image and tag

| extra-args | Extra args to be passed to podman push. Separate arguments by newline. Do not use quotes. | None






### Image, Tag and Registry Inputs

The **push-to-registry** `image` and `tag` input work very similarly to [**buildah-build**](https://github.com/redhat-actions/buildah-build#image-tag-inputs).



However, when using **push-to-registry** when the `tags` input are not fully qualified, the `registry` input must also be set.



So, for **push-to-registry** the options are as follows:



**Option 1**: Provide `registry`, `image`, and `tags` inputs. The image(s) will be pushed to `${registry}/${image}:${tag}`.



For example:

```yaml

registry: quay.io/my-namespace

image: my-image

tags: v1 v1.0.0

```

will push the image tags: `quay.io/my-namespace/my-image:v1` and `quay.io/my-namespace/my-image:v1.0.0`.



**Option 2**: Provide only the `tags` input, including the fully qualified image name in each tag. In this case, the `registry` and `image` inputs are ignored.



For example:

```yaml

# 'registry' and 'image' inputs are not set

tags: quay.io/my-namespace/my-image:v1 quay.io/my-namespace/my-image:v1.0.0

```

will push the image tags: `quay.io/my-namespace/my-image:v1` and `quay.io/my-namespace/my-image:v1.0.0`.



If the `tags` input does not have image names in the `${registry}/${name}:${tag}` form, then the `registry` and `image` inputs must be set.



## Action Outputs



`digest`: The pushed image digest, as written to the `digestfile`.


For example:

```

sha256:66ce924069ec4181725d15aa27f34afbaf082f434f448dc07a42daa3305cdab3

```



For multiple tags, the digest is the same.



`registry-paths`: A JSON array of registry paths to which the tag(s) were pushed.



For example:



```

[ "quay.io/username/spring-image:v1", "quay.io/username/spring-image:latest" ]

```



`registry-path`: The first element of `registry-paths`, as a string.



## Pushing Manifest



If multiple tags are provided, either all tags must point to manifests, or none of them. i.e., you cannot push both manifests are regular images in one `push-to-registry` step.



Refer to [Manifest Build and Push example](./.github/workflows/manifest-build-push.yaml) for a sophisticated example of building and pushing a manifest.



## Examples



The example below shows how the `push-to-registry` action can be used to push an image created by the [**buildah-build**](https://github.com/redhat-actions/buildah-build) action.



```yaml

name: Build and Push Image

on: [ push ]



jobs:

  build:

    name: Build and push image

    runs-on: ubuntu-22.04



    steps:

    - uses: actions/checkout@v4



    - name: Build Image

      id: build-image

      uses: redhat-actions/buildah-build@v2

      with:

        image: my-app

        tags: latest ${{ github.sha }}

        containerfiles: |

          ./Containerfile



    # Podman Login action (https://github.com/redhat-actions/podman-login) also be used to log in,

    # in which case 'username' and 'password' can be omitted.

    - name: Push To quay.io

      id: push-to-quay

      uses: redhat-actions/push-to-registry@v2

      with:

        image: ${{ steps.build-image.outputs.image }}

        tags: ${{ steps.build-image.outputs.tags }}

        registry: quay.io/quay-user

        username: quay-user

        password: ${{ secrets.REGISTRY_PASSWORD }}



    - name: Print image url

      run: echo "Image pushed to ${{ steps.push-to-quay.outputs.registry-paths }}"

```



Refer to [GHCR push example](./.github/workflows/ghcr-push.yaml) for complete example of push to [GitHub Container Registry (GHCR)](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry).



## Note about images built with Docker



This action uses `Podman` to push, but can also push images built with `Docker`. However, Docker and Podman store their images in different locations, and Podman can only push images in its own storage.



If the image to push is present in the Docker image storage but not in the Podman image storage, it will be pulled into Podman's storage.



If the image to push is present in both the Docker and Podman image storage, the action will push the image which was more recently built, and log a warning.



If the action pulled an image from the Docker image storage into the Podman storage, it will be cleaned up from the Podman storage before the action exits.



## Note about GitHub runners and Podman

We recommend using `runs-on: ubuntu-22.04` since it has a newer version of Podman.



If you are on `ubuntu-20.04` or any other older versions of ubuntu your workflow will use an older version of Podman and may encounter issues such as [#26](https://github.com/redhat-actions/push-to-registry/issues/26).



## Troubleshooting

Note that quay.io repositories are private by default.



This means that if you push an image for the first time, you will have to authenticate before pulling it, or go to the repository's settings and change its visibility.



Similarly, if you receive a 403 Forbidden from GHCR, you may have to update the Package Settings. Refer to [this issue](https://github.com/redhat-actions/push-to-registry/issues/52).