Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/k8s-crafts/podman-cli-action

A GitHub Action to emulate Docker CLI using podman
https://github.com/k8s-crafts/podman-cli-action

ci-cd docker github-actions podman

Last synced: about 2 months ago
JSON representation

A GitHub Action to emulate Docker CLI using podman

Host: GitHub
URL: https://github.com/k8s-crafts/podman-cli-action
Owner: k8s-crafts
License: apache-2.0
Created: 2024-08-01T22:44:51.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-08-01T23:54:59.000Z (5 months ago)
Last Synced: 2024-08-03T01:11:06.782Z (5 months ago)
Topics: ci-cd, docker, github-actions, podman
Language: Shell
Homepage:
Size: 12.7 KB
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Podman CLI Action

![Release](https://img.shields.io/badge/Version-v1.2.0-informational?style=flat-square&label=Release)

[![Lint](https://img.shields.io/github/actions/workflow/status/k8s-crafts/podman-cli-action/lint.yaml?style=flat-square&logo=github&label=Lint)](https://github.com/k8s-crafts/podman-cli-action/actions/workflows/lint.yaml)

[![Test](https://img.shields.io/github/actions/workflow/status/k8s-crafts/podman-cli-action/test.yaml?style=flat-square&logo=github&label=Test)](https://github.com/k8s-crafts/podman-cli-action/actions/workflows/test.yaml)

This action provides the functionality to emulate Docker CLI using [`podman`](https://podman.io/) 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](#examples) is available below. For more information, reference the GitHub Help Documentation for [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#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`](https://github.com/k8s-crafts/podman-cli-action) emulates Docker CLI with `podman` on every push event to `main`.

```yaml

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

```