Skip to content
download

GitHub Action

Podman CLI Action

v1.2.0 Latest version

Podman CLI Action

download

Podman CLI Action

A GitHub Action to emulate Docker CLI using podman

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Podman CLI Action

uses: k8s-crafts/[email protected]

Learn more about this action in k8s-crafts/podman-cli-action

Choose a version

Podman CLI Action

Release Lint Test

This action provides the functionality to emulate Docker CLI using podman for GitHub Actions runners. If your use cases expect docker command but would like to use podman as the backend, this is action for you.

Supported Runners

Image YAML Label Supported
Ubuntu 24.04 ubuntu-24.04
Ubuntu 22.04 ubuntu-latest or ubuntu-22.04
Ubuntu 20.04 ubuntu-20.04

Usage

Create a workflow YAML file in your .github/workflows directory. An example workflow is available below. For more information, reference the GitHub Help Documentation for Creating a workflow file.

Inputs

Input Description Default
podman_api Enable Podman API and configure DOCKER_HOST environment variable false

Examples

The example workflow below uses k8s-crafts/podman-cli-action emulates Docker CLI with podman on every push event to main.

name: Build CI

on:
  push:
    branches:
      - main

jobs:
  build-container-image:
    runs-on: ubuntu-latest
    steps:
      - name: Emulate Docker CLI with Podman
        uses: k8s-crafts/podman-cli-action@v1
        # with: # Uncomment to enable Podman API
        #   podman_api: true