Common GitHub workflows used by sdr-enthusiasts' CI/CD workflows.

• sdr-enthusiasts/common-github-workflows
  • Build & Push Docker Images
    • Example
    • Inputs
      • get_version_method
        • Method: cargo_toml_file_in_image
        • Method: cargo_toml_file_in_repo
        • Method: file_in_container
        • Method: git_commit_hash_short
    • Secrets

This action will perform a build & push of docker images.

---
name: ci

on:
  workflow_dispatch:

jobs:
  build_and_push:
    uses: sdr-enthusiasts/common-github-workflows/.github/workflows/build_and_push_image.yml@main
    with:
      push_enabled: true
      ghcr_repo_owner: ${{ github.repository_owner }}
      ghcr_repo: ${{ github.repository }}
      platform_linux_arm32v6_enabled: true
      platform_linux_i386_enabled: true
    secrets:
      ghcr_token: ${{ secrets.GITHUB_TOKEN }}

The syntax is method[:argument=value]

Takes argument file, pointing to a Cargo.toml file inside the image. This file does not need to exist in the image before it is built (ie: it can be generated during the build process).

Example:

build_and_push:
  uses: sdr-enthusiasts/common-github-workflows/.github/workflows/build_and_push_image.yml@main
  with:
    get_version_method: cargo_toml_file_in_image:file=/Cargo.toml

The syntax above will read the version from the version = directive, inside the [package] section of /Cargo.toml after the image is built.

Takes argument file, pointing to a Cargo.toml file inside the repo.

Example:

build_and_push:
  uses: sdr-enthusiasts/common-github-workflows/.github/workflows/build_and_push_image.yml@main
  with:
    get_version_method: cargo_toml_file_in_repo:file=/Cargo.toml

The syntax above will read the version from the version = directive, inside the [package] section of /Cargo.toml in the repo.

Takes argument file, pointing to a file inside the image. This file does not need to exist in the image before it is built (ie: it can be generated during the build process).

Example:

build_and_push:
  uses: sdr-enthusiasts/common-github-workflows/.github/workflows/build_and_push_image.yml@main
  with:
    get_version_method: file_in_container:file=/IMAGE_VERSION

The syntax above will read the contents of the file /IMAGE_VERSION after the image is built.

Takes no arguments. Will use the first 7 characters from the git commit hash. This is retrieved by running git rev-parse HEAD on the checked-out repository.

Example:

build_and_push:
  uses: sdr-enthusiasts/common-github-workflows/.github/workflows/build_and_push_image.yml@main
  with:
    get_version_method: git_commit_hash_short