podman-login/README.md
divyansh42 54f79a2a8b Add README.md
Signed-off-by: divyansh42 <diagrawa@redhat.com>
2021-04-01 14:08:52 +05:30

2.7 KiB

buildah-build

CI checks Build Link checker

tag badge license badge size badge

Podman login is a GitHub Action to login against a container image registry.

This action only runs on Linux, as it uses podman to perform the login. GitHub's Ubuntu action runners come with Podman preinstalled. If you are not using those runners, you must first install Podman.

After logging to container image registry, you may use push-to-registry to push the image and make it pullable.

Action Inputs

Input Name Description Default
registry Server URL of the container image registry. Example: quay.io Must be provided
username Username to login against the container image registry. Must be provided
password Password or token to login against the container image registry. Must be provided
logout Set to false if you don't want to logout to container image registry at the end of the job. true

Example

The example below shows how the podman-login action can be used to login to quay.io container image registry.

name: Login to Quay.io
on:
  push:

env:
  REGISTRY_USER: ${{ secrets.REGISTRY_USER }}
  IMAGE_REGISTRY: quay.io
  REGISTRY_PASSWORD: ${{ secrets.REGISTRY_PASSWORD }}

jobs:
  login:
    name: Login to container image registry
    runs-on: ubuntu-20.04
    steps:

      - name: Login to Quay.io
        uses: redhat-actions/podman-login@v1
        with:
          username: ${{ env.REGISTRY_USER }}
          password: ${{ env.REGISTRY_PASSWORD }}
          registry: ${{ env.IMAGE_REGISTRY }}
          logout: false # Do not logout at the end of the job