2025-03-21 22:48:45 +00:00
---
name : Build Custom Image
2024-12-29 11:52:42 +00:00
on :
2025-03-21 22:48:45 +00:00
pull_request :
branches :
- main
2024-12-29 11:52:42 +00:00
schedule :
2025-03-21 22:48:45 +00:00
- cron : '05 10 * * *' # 10:05am UTC everyday
2024-12-29 11:52:42 +00:00
push :
branches :
- main
2025-03-21 22:48:45 +00:00
paths-ignore :
- '**/README.md'
workflow_dispatch :
env :
2025-03-23 17:49:40 +00:00
IMAGE_NAME : "sst/uphy-test" # the name of the image produced by this build, matches repo names
2025-03-21 22:48:45 +00:00
IMAGE_DESC : "My Customized Universal Blue Image"
2025-03-23 17:49:40 +00:00
IMAGE_REGISTRY : "rievo.dev" # do not edit
2025-03-21 22:48:45 +00:00
ARTIFACTHUB_LOGO_URL : "https://avatars.githubusercontent.com/u/120078124?s=200&v=4" # You should put your own image here so that you get a fancy profile image on https://artifacthub.io/!
concurrency :
group : ${{ github.workflow }}-${{ github.ref || github.run_id }}-${{ inputs.brand_name}}-${{ inputs.stream_name }}
cancel-in-progress : true
2024-12-29 11:52:42 +00:00
jobs :
2025-03-21 22:48:45 +00:00
build_push :
name : Build and push image
runs-on : buildah-latest
permissions :
contents : read
packages : write
id-token : write
2024-12-29 11:52:42 +00:00
steps :
2025-03-21 22:48:45 +00:00
# These stage versions are pinned by https://github.com/renovatebot/renovate
- name : Checkout
2025-03-21 22:51:08 +00:00
uses : https://github.com/actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
2024-12-29 11:52:42 +00:00
2025-03-23 17:42:37 +00:00
# - name: Workaround open podman-login action issue
# env:
# auth: "{ \"auths\": {} }"
# run: |
# mkdir -p $HOME/.docker
# echo $auth > $HOME/.docker/config.json
2025-03-22 10:17:52 +00:00
2025-03-23 17:42:37 +00:00
# - name: Log in to the GitHub Container registry
# uses: https://github.com/redhat-actions/podman-login@4934294ad0449894bcd1e9f191899d7292469603 # master
# with:
# registry: rievo.dev
# username: ${{ github.actor }}
# password: ${{ secrets.GITHUB_TOKEN }}
# auth_file_path: /run/containers/0/auth.json
2025-03-22 10:17:52 +00:00
2025-03-21 22:48:45 +00:00
# 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 : Get current date
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
uses : https://github.com/docker/metadata-action@902fa8ec7d6ecbf8d84d538b9b233a880e428804 # v5
id : metadata
with :
# This generates all the tags for your image, you can add custom tags here too!
# By default, it should generate "latest" and "latest.(date here)".
tags : |
type=raw,value=latest
type=raw,value=latest.{{date 'YYYYMMDD'}}
type=raw,value={{date 'YYYYMMDD'}}
type=sha,enable=${{ github.event_name == 'pull_request' }}
type=ref,event=pr
labels : |
io.artifacthub.package.readme-url=https://raw.githubusercontent.com/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}/refs/heads/main/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 }}/refs/heads/main/README.md
org.opencontainers.image.source=https://github.com/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}/blob/main/Containerfile
org.opencontainers.image.title=${{ env.IMAGE_NAME }}
org.opencontainers.image.url=https://github.com/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}
org.opencontainers.image.vendor=${{ github.repository_owner }}
org.opencontainers.image.version=latest
io.artifacthub.package.deprecated=false
io.artifacthub.package.keywords=bootc,ublue,universal-blue
io.artifacthub.package.license=Apache-2.0
io.artifacthub.package.logo-url=${{ env.ARTIFACTHUB_LOGO_URL }}
io.artifacthub.package.prerelease=false
containers.bootc=1
sep-tags : " "
sep-annotations : " "
- name : Build Image
id : build_image
uses : https://github.com/redhat-actions/buildah-build@7a95fa7ee0f02d552a32753e7414641a04307056 # v2
2024-12-29 11:52:42 +00:00
with :
containerfiles : |
./Containerfile
2025-03-21 22:48:45 +00:00
# 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 }}
tags : ${{ steps.metadata.outputs.tags }}
labels : ${{ steps.metadata.outputs.labels }}
oci : false
2024-12-29 11:52:42 +00:00
2025-03-21 22:48:45 +00:00
# Rechunk is a script that we use on Universal Blue to make sure there isnt a single huge layer when your image gets published.
# This does not make your image faster to download, just provides better resumability and fixes a few errors.
# Documentation for Rechunk is provided on their github repository at https://github.com/hhd-dev/rechunk
# You can enable it by uncommenting the following lines:
2025-03-23 18:39:41 +00:00
- name : Run Rechunker
id : rechunk
2025-03-23 19:14:40 +00:00
uses : https://github.com/hhd-dev/rechunk@c945e9ec8ad4466f888e41ab7f4d5ba2f74a8ee4 # v1.2.1
2025-03-23 18:39:41 +00:00
with :
rechunk : 'ghcr.io/hhd-dev/rechunk:v1.0.1'
2025-03-23 18:44:32 +00:00
ref : "${{ env.IMAGE_NAME }}:latest"
prev-ref : "${{ env.IMAGE_REGISTRY }}/${{ env.IMAGE_NAME }}:latest"
2025-03-23 18:39:41 +00:00
skip_compression : true
version : ${{ env.CENTOS_VERSION }}
labels : ${{ steps.metadata.outputs.labels }} # Rechunk strips out all the labels during build, this needs to be reapplied here with newline separator
2025-03-21 22:48:45 +00:00
2025-03-21 23:47:32 +00:00
# This is necessary so that the podman socket can find the rechunked image on its storage
2025-03-23 18:39:41 +00:00
- name : Load in podman and tag
run : |
IMAGE=$(podman pull ${{ steps.rechunk.outputs.ref }})
sudo rm -rf ${{ steps.rechunk.outputs.output }}
for tag in ${{ steps.metadata.outputs.tags }}; do
podman tag $IMAGE ${{ env.IMAGE_NAME }}:$tag
done
2025-03-22 10:00:20 +00:00
2025-03-21 22:48:45 +00:00
# Workaround bug where capital letters in your GitHub username make it impossible to push to GHCR.
# https://github.com/macbre/push-to-ghcr/issues/12
# - name: Lowercase Registry
# id: registry_case
# uses: ASzc/change-string-case-action@d0603cd0a7dd490be678164909f65c7737470a7f # v6
# with:
# string: ${{ env.IMAGE_REGISTRY }}
# - name: Lowercase Image
# id: image_case
# uses: ASzc/change-string-case-action@d0603cd0a7dd490be678164909f65c7737470a7f # v6
# with:
# string: ${{ env.IMAGE_NAME }}
2025-03-23 17:41:54 +00:00
- name : Push To Registry
2025-03-22 10:00:20 +00:00
uses : https://github.com/redhat-actions/push-to-registry@5ed88d269cf581ea9ef6dd6806d01562096bee9c # v2
if : github.event_name != 'pull_request' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
id : push
env :
REGISTRY_USER : ${{ github.actor }}
2025-03-23 18:27:58 +00:00
REGISTRY_PASSWORD : ${{ secrets.REGISTRY_TOKEN }}
2025-03-22 10:00:20 +00:00
with :
2025-03-23 17:49:40 +00:00
registry : ${{ env.IMAGE_REGISTRY }}
2025-03-22 10:00:20 +00:00
image : ${{ env.IMAGE_NAME }}
2025-03-23 17:41:54 +00:00
tags : ${{ steps.metadata.outputs.tags }}
username : ${{ env.REGISTRY_USER }}
password : ${{ env.REGISTRY_PASSWORD }}
2025-03-21 22:48:45 +00:00
# This section is optional and only needs to be enabled if you plan on distributing
# your project for others to consume. You will need to create a public and private key
# using Cosign and save the private key as a repository secret in Github for this workflow
# to consume. For more details, review the image signing section of the README.
# - name: Install Cosign
# uses: sigstore/cosign-installer@d7d6bc7722e3daa8354c50bcb52f4837da5e9b6a # v3.8.1
# if: github.event_name != 'pull_request' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
# - name: Sign container image
# if: github.event_name != 'pull_request' && github.ref == format('refs/heads/{0}', github.event.repository.default_branch)
# run: |
# IMAGE_FULL="${{ steps.registry_case.outputs.lowercase }}/${{ steps.image_case.outputs.lowercase }}"
# for tag in ${{ steps.metadata.outputs.tags }}; do
# cosign sign -y --key env://COSIGN_PRIVATE_KEY $IMAGE_FULL:$tag
# done
# env:
# TAGS: ${{ steps.push.outputs.digest }}
# COSIGN_EXPERIMENTAL: false
# COSIGN_PRIVATE_KEY: ${{ secrets.SIGNING_SECRET }}