docker-publish.yml

---
name: Build and publish the Docker image

on:  # yamllint disable-line rule:truthy
  push:
    branches:
      - main
      - develop
  pull_request:
    branches:
      - main
      - develop
  workflow_dispatch:

env:
  REGISTRY: ghcr.io
  IMAGE_NAME: ideaconsult/template-designer

jobs:

  build:

    runs-on: ubuntu-latest
    permissions:
      contents: read
      packages: write
      # This is used to complete the identity challenge
      # with sigstore/fulcio when running outside of PRs.
      id-token: write

    steps:

      - name: Checkout repository
        uses: actions/checkout@v4.2.2
        with:
          submodules: recursive

      - name: Run Cypress
        uses: cypress-io/github-action@v6.7.8
        with:
          start: npm run build-serve
          wait-on: http://127.0.0.1:50722/templates/

      # TODO: Temporary solution for using different backends.
      - name: Set up appropriate backend
        run: >-
          if [[ '${{ github.event_name }}' == 'pull_request' ]]; then
            api_url='https://api-test2.ramanchada.ideaconsult.net/template'
          elif [[ '${{ github.ref }}' == 'refs/heads/main' ]]; then
            api_url="https://api.ramanchada.ideaconsult.net/template"
          elif [[ '${{ github.ref }}' == 'refs/heads/develop' ]]; then
            api_url='https://api-test.ramanchada.ideaconsult.net/template'
          else
            api_url='https://api-test.ramanchada.ideaconsult.net/template'
          fi

          sed -i "/[[:blank:]]*apiUrl: /s|: \".*\",|: \"${api_url}\",|" src/utils/config.ts

      # Install the cosign tool except on PR
      # https://github.com/sigstore/cosign-installer
      - name: Install cosign
        if: github.event_name != 'pull_request'
        uses: sigstore/cosign-installer@v3.7.0
        with:
          cosign-release: 'v2.4.1'

      # Workaround: https://github.com/docker/build-push-action/issues/461
      - name: Setup Docker buildx
        uses: docker/setup-buildx-action@v3.7.1

      # Login against a Docker registry except on PR
      # https://github.com/docker/login-action
      - name: Log into registry ${{ env.REGISTRY }}
        if: github.event_name != 'pull_request'
        uses: docker/login-action@v3.3.0
        with:
          registry: ${{ env.REGISTRY }}
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}

      # Extract metadata (tags, labels) for Docker
      # https://github.com/docker/metadata-action
      - name: Extract Docker metadata
        id: meta
        uses: docker/metadata-action@v5.6.1
        with:
          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
          labels: |
            org.opencontainers.image.description=Template Designer Service
            org.opencontainers.image.licenses=MIT
            org.opencontainers.image.title=template-designer
            org.opencontainers.image.url=https://github.com/ideaconsult/templateforge/blob/main/README.md
            org.opencontainers.image.vendor=IDEAconsult
          tags: |
            type=raw,value=latest,enable=${{ github.ref == 'refs/heads/develop' }}
            type=raw,value=stable,enable=${{ github.ref == 'refs/heads/main' }}
            type=ref,event=branch
            type=ref,event=tag
            type=ref,event=pr

      # Build and push Docker image with Buildx (don't push on PR)
      # https://github.com/docker/build-push-action
      - name: Build and push Docker image
        id: build-and-push
        uses: docker/build-push-action@v6.10.0
        with:
          cache-from: type=gha
          cache-to: type=gha,mode=max
          context: .
          labels: ${{ steps.meta.outputs.labels }}
          outputs: type=docker,dest=template-designer.tar
          push: ${{ github.event_name != 'pull_request' }}
          tags: ${{ steps.meta.outputs.tags }}

      - name: Upload the built image as artifact for download
        uses: actions/upload-artifact@v4.4.3
        with:
          name: template-designer.tar
          path: template-designer.tar

      # Sign the resulting Docker image digest except on PRs.
      # This will only write to the public Rekor transparency log when the Docker
      # repository is public to avoid leaking data.  If you would like to publish
      # transparency data even for private images, pass --force to cosign below.
      # https://github.com/sigstore/cosign
      - name: Sign the published Docker image
        if: github.event_name != 'pull_request'
        env:
          # https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions#using-an-intermediate-environment-variable
          TAGS: ${{ steps.meta.outputs.tags }}
          DIGEST: ${{ steps.build-and-push.outputs.digest }}
        # This step uses the identity token to provision an ephemeral certificate
        # against the sigstore community Fulcio instance.
        run: echo "${TAGS}" | xargs -I {} cosign sign --yes {}@${DIGEST}