build.yml

# SPDX-FileCopyrightText: © Vegard IT GmbH (https://vegardit.com)
# SPDX-FileContributor: Sebastian Thomschke
# SPDX-License-Identifier: Apache-2.0
# SPDX-ArtifactOfProjectHomePage: https://github.com/vegardit/docker-softhsm2-pkcs11-proxy
#
# https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
name: Build

on:  # https://docs.github.com/en/actions/reference/events-that-trigger-workflows
  schedule:
    # https://docs.github.com/en/actions/reference/choosing-when-your-workflow-runs/events-that-trigger-workflows
    - cron: '0 17 * * 3'
  push:
    branches-ignore:  # build all branches except:
    - 'dependabot/**'  # prevent GHA triggered twice (once for commit to the branch and once for opening/syncing the PR)
    tags-ignore:  # don't build tags
    - '**'
    paths-ignore:
    - '**/*.md'
    - '.editorconfig'
    - '.git*'
    - '.github/*.yml'
    - '.github/workflows/stale.yml'
  pull_request:
    paths-ignore:
    - '**/*.md'
    - '.editorconfig'
    - '.git*'
    - '.github/*.yml'
    - '.github/workflows/stale.yml'
  workflow_dispatch:
    # https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_dispatch


defaults:
  run:
    shell: bash


env:
  DOCKER_REPO_NAME: softhsm2-pkcs11-proxy
  TRIVY_CACHE_DIR: ~/.trivy/cache


jobs:

  ###########################################################
  build:
  ###########################################################
    runs-on: ubuntu-latest  # https://github.com/actions/runner-images#available-images
    timeout-minutes: 60

    permissions:
      packages: write

    strategy:
      matrix:
        SOFTHSM_VERSION: [ "latest", "develop" ]
        DOCKER_BASE_IMAGE: [ alpine:3, "debian:stable-slim" ]

    steps:
    - name: "Show: GitHub context"
      env:
        GITHUB_CONTEXT: ${{ toJSON(github) }}
      run: printf '%s' "$GITHUB_CONTEXT" | python -m json.tool


    - name: "Show: environment variables"
      run: env | sort


    - name: Git Checkout
      uses: actions/checkout@v6  # https://github.com/actions/checkout


    - name: Run the sh-checker
      uses: luizm/action-sh-checker@master  # https://github.com/marketplace/actions/sh-checker
      env:
        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        SHFMT_OPTS: --simplify --keep-padding
      with:
         sh_checker_comment: true
         sh_checker_checkbashisms_enable: true
         sh_checker_shfmt_disable: true


    - name: Check Alpine Dockerfile
      uses: hadolint/hadolint-action@v3.3.0
      if: ${{ contains(matrix.DOCKER_BASE_IMAGE, 'alpine') }}
      with:
        dockerfile: image/alpine.Dockerfile


    - name: Check Debian Dockerfile
      uses: hadolint/hadolint-action@v3.3.0
      if: ${{ contains(matrix.DOCKER_BASE_IMAGE, 'debian') }}
      with:
        dockerfile: image/debian.Dockerfile


    - name: Cache trivy cache
      uses: actions/cache@v5
      with:
        path: ${{ env.TRIVY_CACHE_DIR }}
        # https://github.com/actions/cache/issues/342#issuecomment-673371329
        key: ${{ runner.os }}-trivy-${{ github.run_id }}
        restore-keys: |
          ${{ runner.os }}-trivy-


    - name: Configure fast APT repository mirror
      uses: vegardit/fast-apt-mirror.sh@v1


    - name: Install dos2unix
      run: sudo apt-get install --no-install-recommends -y dos2unix


    - name: "Determine if docker images shall be published"
      id: docker_push_actions
      run: |
        # ACT -> https://nektosact.com/usage/index.html#skipping-steps
        set -x
        if [[ $GITHUB_REF_NAME == 'main' && $GITHUB_EVENT_NAME != 'pull_request' && -z "$ACT" ]]; then
          echo "DOCKER_PUSH_GHCR=true" >> "$GITHUB_ENV"
          echo "DOCKER_PUSH_GHCR=true" >> $GITHUB_OUTPUT
          if [[ -n "${{ secrets.DOCKER_HUB_USERNAME }}" ]]; then
            echo "DOCKER_PUSH=true" >> "$GITHUB_ENV"
          fi
        fi


    - name: Login to docker.io
      if: ${{ env.DOCKER_PUSH }}
      uses: docker/login-action@v3
      with:
        username: ${{ secrets.DOCKER_HUB_USERNAME }}
        password: ${{ secrets.DOCKER_HUB_TOKEN }}


    - name: Login to ghcr.io
      if: ${{ env.DOCKER_PUSH_GHCR }}
      uses: docker/login-action@v3
      with:
        registry: ghcr.io
        username: ${{ github.actor }}
        password: ${{ secrets.GITHUB_TOKEN }}


    - name: Build ${{ env.DOCKER_REPO_NAME }}:${{ matrix.SOFTHSM_VERSION }}
      env:
        DOCKER_BASE_IMAGE: ghcr.io/dockerhub-mirror/${{ matrix.DOCKER_BASE_IMAGE }}
        DOCKER_IMAGE_REPO: ${{ github.repository_owner }}/${{ env.DOCKER_REPO_NAME }}
        SOFTHSM_VERSION: ${{ matrix.SOFTHSM_VERSION }}
        TRIVY_GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      run: bash build-image.sh

    outputs:
      DOCKER_PUSH_GHCR: ${{ steps.docker_push_actions.outputs.DOCKER_PUSH_GHCR }}


  ###########################################################
  delete-untagged-images:
  ###########################################################
    runs-on: ubuntu-latest  # https://github.com/actions/runner-images#available-images
    timeout-minutes: 5
    needs: [build]
    if: ${{ needs.build.outputs.DOCKER_PUSH_GHCR }}

    concurrency:
      group: ${{ github.workflow }}
      cancel-in-progress: false

    permissions:
      packages: write

    steps:
    - name: Delete untagged images
      uses: dataaxiom/ghcr-cleanup-action@v1
      with:
        package: ${{ env.DOCKER_REPO_NAME }}
        delete-untagged: true
        delete-partial-images: true
        delete-ghost-images: true
        delete-orphaned-images: true
        validate: true