Update build.yml

This commit is contained in:
humocs-man
2026-03-26 19:33:01 +01:00
committed by GitHub
parent 3b7aedd86c
commit 764b1a40d4
+28 -150
View File
@@ -1,218 +1,96 @@
---
name: Build container image name: Build container image
on: on:
pull_request: pull_request:
branches: branches:
- main - main
# schedule: # schedule:
# - cron: '05 10 * * *' # 10:05am UTC everyday # - cron: '05 10 * * *' # 10:05 UTC daily
# push:
# branches:
# - main
# paths-ignore:
# - '**/README.md'
workflow_dispatch: workflow_dispatch:
env: env:
IMAGE_DESC: "My Customized Universal Blue Image" IMAGE_NAME: "${{ github.event.repository.name }}"
IMAGE_KEYWORDS: "bootc,ublue,universal-blue" IMAGE_REGISTRY: "ghcr.io/${{ github.repository_owner }}"
IMAGE_LOGO_URL: "https://avatars.githubusercontent.com/u/120078124?s=200&v=4" # Put your own image here for a fancy profile on https://artifacthub.io/!
IMAGE_NAME: "${{ github.event.repository.name }}" # output image name, usually same as repo name
IMAGE_REGISTRY: "ghcr.io/${{ github.repository_owner }}" # do not edit
DEFAULT_TAG: "stable" DEFAULT_TAG: "stable"
concurrency: concurrency:
group: ${{ github.workflow }}-${{ github.ref || github.run_id }}-${{ inputs.brand_name}}-${{ inputs.stream_name }} group: ${{ github.workflow }}-${{ github.ref || github.run_id }}
cancel-in-progress: true cancel-in-progress: true
jobs: jobs:
build_push: build_push:
name: Build and push image name: Build and push image (private)
runs-on: ubuntu-24.04 runs-on: ubuntu-24.04
permissions: permissions:
contents: read contents: read
packages: write packages: write
id-token: write
steps: steps:
- name: Prepare environment - name: Prepare environment
run: | run: |
# Lowercase the image uri
echo "IMAGE_REGISTRY=${IMAGE_REGISTRY,,}" >> ${GITHUB_ENV}
echo "IMAGE_NAME=${IMAGE_NAME,,}" >> ${GITHUB_ENV} echo "IMAGE_NAME=${IMAGE_NAME,,}" >> ${GITHUB_ENV}
echo "IMAGE_REGISTRY=${IMAGE_REGISTRY,,}" >> ${GITHUB_ENV}
# These stage versions are pinned by https://github.com/renovatebot/renovate
- name: Checkout - name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v5 uses: actions/checkout@v5
# This is optional, but if you see that your builds are way too big for the runners, you can enable this by uncommenting the following lines:
# - name: Maximize build space
# uses: ublue-os/remove-unwanted-software@517622d6452028f266b7ba4cc9a123b5f58a6b53 # v7
# with:
# remove-codeql: true
- name: Mount BTRFS for podman storage - name: Mount BTRFS for podman storage
id: container-storage-action uses: ublue-os/container-storage-action@main
uses: ublue-os/container-storage-action@911baca08baf30c8654933e9e9723cb399892140 # main
# Fallback to the remove-unwanted-software-action if github doesn't allocate enough space
# See: https://github.com/ublue-os/container-storage-action/pull/11
continue-on-error: true continue-on-error: true
with: with:
target-dir: /var/lib/containers target-dir: /var/lib/containers
mount-opts: compress-force=zstd:2 mount-opts: compress-force=zstd:2
- name: Get current date # Minimal, private metadata no public URLs, no ArtifactHub
id: date
run: |
# This generates a timestamp like what is defined on the ArtifactHub documentation
# E.G: 2022-02-08T15:38:15Z'
# https://artifacthub.io/docs/topics/repositories/container-images/
# https://linux.die.net/man/1/date
echo "date=$(date -u +%Y\-%m\-%d\T%H\:%M\:%S\Z)" >> $GITHUB_OUTPUT
# Image metadata for https://artifacthub.io/ - This is optional but is highly recommended so we all can get a index of all the custom images
# The metadata by itself is not going to do anything, you choose if you want your image to be on ArtifactHub or not.
- name: Image Metadata - name: Image Metadata
uses: docker/metadata-action@030e881283bb7a6894de51c315a6bfe6a94e05cf # v5 uses: docker/metadata-action@v5
id: metadata id: metadata
with: with:
# This generates all the tags for your image, you can add custom tags here too!
# Default tags are "$DEFAULT_TAG" and "$DEFAULT_TAG.$date".
tags: | tags: |
type=raw,value=${{ env.DEFAULT_TAG }} type=raw,value=${{ env.DEFAULT_TAG }}
type=raw,value=${{ env.DEFAULT_TAG }}.{{date 'YYYYMMDD'}}
type=raw,value={{date 'YYYYMMDD'}}
type=sha,enable=${{ github.event_name == 'pull_request' }}
type=ref,event=pr
labels: | labels: |
io.artifacthub.package.readme-url=https://raw.githubusercontent.com/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}/${{ github.sha }}/README.md
org.opencontainers.image.created=${{ steps.date.outputs.date }}
org.opencontainers.image.description=${{ env.IMAGE_DESC }}
org.opencontainers.image.documentation=https://raw.githubusercontent.com/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}/${{ github.sha }}/README.md
org.opencontainers.image.source=https://github.com/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}/blob/${{ github.sha }}/Containerfile
org.opencontainers.image.title=${{ env.IMAGE_NAME }} org.opencontainers.image.title=${{ env.IMAGE_NAME }}
org.opencontainers.image.url=https://github.com/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}/tree/${{ github.sha }} org.opencontainers.image.version=${{ env.DEFAULT_TAG }}
org.opencontainers.image.vendor=${{ github.repository_owner }}
org.opencontainers.image.version=${{ env.DEFAULT_TAG }}.{{date 'YYYYMMDD'}}
io.artifacthub.package.deprecated=false
io.artifacthub.package.keywords=${{ env.IMAGE_KEYWORDS }}
io.artifacthub.package.license=Apache-2.0
io.artifacthub.package.logo-url=${{ env.IMAGE_LOGO_URL }}
io.artifacthub.package.prerelease=false
containers.bootc=1 containers.bootc=1
sep-tags: " "
sep-annotations: " "
- name: Build Image - name: Build Image
id: build_image uses: redhat-actions/buildah-build@v2
uses: redhat-actions/buildah-build@7a95fa7ee0f02d552a32753e7414641a04307056 # v2
with: with:
containerfiles: | containerfiles: |
./Containerfile ./Containerfile
# Postfix image name with -custom to make it a little more descriptive
# Syntax: https://docs.github.com/en/actions/learn-github-actions/expressions#format
image: ${{ env.IMAGE_NAME }} image: ${{ env.IMAGE_NAME }}
tags: ${{ env.DEFAULT_TAG }} tags: ${{ env.DEFAULT_TAG }}
labels: ${{ steps.metadata.outputs.labels }} labels: ${{ steps.metadata.outputs.labels }}
oci: false oci: false
# Tag for registry
- name: Tag for registry
run: |
for tag in ${{ steps.metadata.outputs.tags }}; do
podman tag ${{ env.IMAGE_NAME }}:${{ env.DEFAULT_TAG }} ${{ env.IMAGE_NAME }}:$tag
done
# SBOM (OPTIONAL): Software Bill of Materials generation using Syft
# Creates a detailed inventory of all software components in the image for supply chain security.
# To enable:
# 1. Uncomment the "Setup Syft" step below
# 2. Uncomment the "Generate SBOM" step below
# 3. If using image signing, also uncomment the "Add SBOM Attestation" step further down
# Documentation: https://github.com/anchore/syft
# - name: Setup Syft
# id: setup-syft
# uses: anchore/sbom-action/download-syft@8e94d75ddd33f69f691467e42275782e4bfefe84 # v0.20.9
# with:
# syft-version: v1.20.0
#
# - name: Generate SBOM
# id: generate-sbom
# env:
# IMAGE: ${{ env.IMAGE_NAME }}
# DEFAULT_TAG: ${{ env.DEFAULT_TAG }}
# SYFT_CMD: ${{ steps.setup-syft.outputs.cmd }}
# run: |
# OUTPUT_PATH="$(mktemp -d)/sbom.json"
# export SYFT_PARALLELISM=$(($(nproc)*2))
# $SYFT_CMD ${IMAGE}:${DEFAULT_TAG} -o spdx-json=${OUTPUT_PATH}
# echo "OUTPUT_PATH=${OUTPUT_PATH}" >> $GITHUB_OUTPUT
# These `if` statements are so that pull requests for your custom images do not make it publish any packages under your name without you knowing
# They also check if the runner is on the default branch so that things like the merge queue (if you enable it), are going to work
- name: Login to GitHub Container Registry - name: Login to GitHub Container Registry
uses: docker/login-action@b45d80f862d83dbcd57f89517bcf500b2ab88fb2 # v3 if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
if: github.event_name != 'pull_request' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch) uses: docker/login-action@v3
with: with:
registry: ghcr.io registry: ghcr.io
username: ${{ github.actor }} username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }} password: ${{ secrets.GITHUB_TOKEN }}
- name: Push To GHCR - name: Push to GHCR (private)
uses: redhat-actions/push-to-registry@5ed88d269cf581ea9ef6dd6806d01562096bee9c # v2 if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
if: github.event_name != 'pull_request' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch) uses: redhat-actions/push-to-registry@v2
id: push
env:
REGISTRY_USER: ${{ github.actor }}
REGISTRY_PASSWORD: ${{ github.token }}
with: with:
registry: ${{ env.IMAGE_REGISTRY }} registry: ${{ env.IMAGE_REGISTRY }}
image: ${{ env.IMAGE_NAME }} image: ${{ env.IMAGE_NAME }}
tags: ${{ steps.metadata.outputs.tags }} tags: ${{ env.DEFAULT_TAG }}
username: ${{ env.REGISTRY_USER }}
password: ${{ env.REGISTRY_PASSWORD }}
# OPTIONAL: Image Signing with Cosign
# Signing is disabled by default. To enable, see README.md "Optional: Enable Image Signing" section.
- name: Install Cosign - name: Install Cosign
uses: sigstore/cosign-installer@ba7bc0a3fef59531c69a25acd34668d6d3fe6f22 # v4.1.0 if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
if: github.event_name != 'pull_request' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch) uses: sigstore/cosign-installer@v4.1.0
- name: Sign container image - name: Sign image (private)
if: github.event_name != 'pull_request' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch) if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
run: | run: |
IMAGE_FULL="${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAME }}" cosign sign -y \
for tag in ${{ steps.metadata.outputs.tags }}; do --key env://COSIGN_PRIVATE_KEY \
cosign sign -y --key env://COSIGN_PRIVATE_KEY $IMAGE_FULL:$tag ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAME }}:${{ env.DEFAULT_TAG }}
done
env: env:
TAGS: ${{ steps.push.outputs.digest }}
COSIGN_EXPERIMENTAL: false
COSIGN_PRIVATE_KEY: ${{ secrets.SIGNING_SECRET }} COSIGN_PRIVATE_KEY: ${{ secrets.SIGNING_SECRET }}
# OPTIONAL: SBOM Attestation
# Attaches SBOM (Software Bill of Materials) to your signed image for supply chain security.
# Requires image signing to be enabled first (see above).
# To enable:
# 1. First enable image signing (see above section)
# 2. Uncomment the "Add SBOM Attestation" step below
# Documentation: https://slsa.dev/spec/v1.0/requirements#provenance-available
# - name: Add SBOM Attestation
# if: github.event_name != 'pull_request' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
# env:
# IMAGE: ${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAME }}
# DIGEST: ${{ steps.push.outputs.digest }}
# COSIGN_PRIVATE_KEY: ${{ secrets.SIGNING_SECRET }}
# SBOM_OUTPUT: ${{ steps.generate-sbom.outputs.OUTPUT_PATH }}
# run: |
# cd "$(dirname "$SBOM_OUTPUT")"
# cosign attest -y \
# --predicate "$(basename "$SBOM_OUTPUT")" \
# --type spdxjson \
# --key env://COSIGN_PRIVATE_KEY \
# "${IMAGE}@${DIGEST}"