Release Docker Image #2
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Release Docker Image | |
| on: | |
| pull_request: | |
| push: | |
| paths-ignore: | |
| - '.gitlab-ci.yml' | |
| - '.gitignore' | |
| - 'renovate.json' | |
| - 'debian/**' | |
| - 'docker/**' | |
| branches: | |
| - main | |
| tags: | |
| - '*' | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| env: | |
| DOCKERHUB_TOKEN: ${{ secrets.DOCKERHUB_TOKEN }} | |
| GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN }} | |
| GHCR_ENABLED: "${{ (github.event_name != 'pull_request' || github.event.pull_request.head.repo.fork == false) && 'true' || 'false' }}" | |
| jobs: | |
| define-variables: | |
| runs-on: ubuntu-latest | |
| outputs: | |
| images: ${{ steps.var.outputs.images }} | |
| images_list: ${{ steps.var.outputs.images_list }} | |
| build_matrix: ${{ steps.var.outputs.build_matrix }} | |
| merge_matrix: ${{ steps.var.outputs.merge_matrix }} | |
| ghcr_image: ${{ steps.var.outputs.ghcr_image }} | |
| docker_image: ${{ steps.var.outputs.docker_image }} | |
| glhr_image: ${{ steps.var.outputs.glhr_image }} | |
| steps: | |
| - name: Setting variables | |
| uses: actions/github-script@v7 | |
| id: var | |
| with: | |
| script: | | |
| const githubRepo = '${{ github.repository }}'.toLowerCase() | |
| const repoId = githubRepo.split('/')[1] | |
| core.setOutput('github_repository', githubRepo) | |
| const ghcrImage = 'ghcr.io/' + githubRepo | |
| const glhrImage = 'registry.gitlab.com/' + '${{ vars.GITLAB_USERNAME }}'.toLowerCase() + '/' + repoId | |
| const dockerImage = 'docker.io/' + '${{ vars.DOCKER_USERNAME }}'.toLowerCase() + '/' + repoId | |
| core.setOutput('ghcr_image', ghcrImage) | |
| core.setOutput('docker_image', dockerImage) | |
| core.setOutput('glhr_image', glhrImage) | |
| let images = [] | |
| if (process.env.GHCR_ENABLED === "true") { | |
| images.push(ghcrImage) | |
| } | |
| if (process.env.DOCKERHUB_TOKEN) { | |
| images.push(dockerImage) | |
| } | |
| if (process.env.GITLAB_TOKEN) { | |
| images.push(glhrImage) | |
| } | |
| core.setOutput('images', images.join("\n")) | |
| core.setOutput('images_list', images.join(",")) | |
| const platforms = ['linux/amd64', 'linux/arm64'] | |
| // specific CPU build variations | |
| const includes = [ | |
| { | |
| platform: 'linux/amd64', | |
| target_cpu: 'haswell', | |
| tag_suffix: '-haswell' | |
| } | |
| ] | |
| // Image builds | |
| core.setOutput('build_matrix', JSON.stringify({ | |
| platform: platforms, | |
| target_cpu: ['base'], | |
| include: includes | |
| })) | |
| // image publishes | |
| core.setOutput('merge_matrix', JSON.stringify({ | |
| tag_suffix: ['', ...includes.map((i) => i.tag_suffix).filter((i) => typeof i == 'string')] | |
| })) | |
| build-image: | |
| runs-on: ubuntu-latest | |
| # only build if we can push to at least one registry | |
| if: needs.define-variables.outputs.images != '' | |
| needs: define-variables | |
| # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job. | |
| permissions: | |
| contents: read | |
| packages: write | |
| attestations: write | |
| id-token: write | |
| strategy: | |
| matrix: ${{ fromJSON(needs.define-variables.outputs.build_matrix) }} | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| # For publishing multi-platform manifests | |
| - name: Prepare | |
| run: | | |
| platform=${{ matrix.platform }} | |
| echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV | |
| - name: Set up QEMU | |
| uses: docker/setup-qemu-action@v3 | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 | |
| # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here. | |
| - name: Login to GitHub Container Registry | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Login to Docker Hub | |
| if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }} | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: docker.io | |
| username: ${{ vars.DOCKER_USERNAME }} | |
| password: ${{ secrets.DOCKERHUB_TOKEN }} | |
| - name: Login to GitLab Container Registry | |
| if: ${{ (vars.GITLAB_USERNAME != '') && (env.GITLAB_TOKEN != '') }} | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: registry.gitlab.com | |
| username: ${{ vars.GITLAB_USERNAME }} | |
| password: ${{ secrets.GITLAB_TOKEN }} | |
| # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels. | |
| - name: Extract metadata (labels, annotations) for Docker | |
| id: meta | |
| uses: docker/metadata-action@v5 | |
| with: | |
| images: ${{needs.define-variables.outputs.images}} | |
| # default labels & annotations: https://github.com/docker/metadata-action/blob/master/src/meta.ts#L509 | |
| env: | |
| DOCKER_METADATA_ANNOTATIONS_LEVELS: manifest,index | |
| # These steps work around docker mount caches not being cached between runs in CI providers. | |
| # It manually injects the mounts into Docker. | |
| # We use | |
| - uses: Swatinem/rust-cache@v2 | |
| with: | |
| prefix-key: v0-rust-${{matrix.platform}}-${{matrix.target_cpu}} | |
| id: rust-cache | |
| - name: Inject cache into Docker | |
| uses: reproducible-containers/buildkit-cache-dance@v3.1.2 | |
| with: | |
| cache-map: | | |
| { | |
| "/home/runner/.cargo/registry": "/usr/local/cargo/registry", | |
| "/home/runner/.cargo/git/db": "/usr/local/cargo/git/db", | |
| "./target": "/app/target" | |
| } | |
| # skip-extraction: ${{ steps.rust-cache.outputs.cache-hit }} | |
| # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages. | |
| # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository. | |
| # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step. | |
| # It will not push images generated from a pull request | |
| - name: Get short git commit SHA | |
| id: sha | |
| run: | | |
| calculatedSha=$(git rev-parse --short ${{ github.sha }}) | |
| echo "COMMIT_SHORT_SHA=$calculatedSha" >> $GITHUB_ENV | |
| - name: Get Git commit timestamps | |
| run: echo "TIMESTAMP=$(git log -1 --pretty=%ct)" >> $GITHUB_ENV | |
| - name: Build and push Docker image by digest | |
| id: build | |
| uses: docker/build-push-action@v6 | |
| with: | |
| context: . | |
| file: "Containerfile" | |
| build-args: | | |
| ${{ matrix.target_cpu != 'base' && format('TARGET_CPU={0}', matrix.target_cpu) || '' }} | |
| CONDUWUIT_VERSION_EXTRA=${{ env.COMMIT_SHORT_SHA }} | |
| platforms: ${{ matrix.platform }} | |
| labels: ${{ steps.meta.outputs.labels }} | |
| annotations: ${{ steps.meta.outputs.annotations }} | |
| cache-from: type=gha | |
| cache-to: type=gha,mode=max | |
| sbom: true | |
| outputs: type=image,"name=${{ needs.define-variables.outputs.images_list }}",push-by-digest=true,name-canonical=true,push=true | |
| env: | |
| SOURCE_DATE_EPOCH: ${{ env.TIMESTAMP }} | |
| # This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see "[Using artifact attestations to establish provenance for builds](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds)." | |
| - name: Generate artifact attestation (${{ needs.define-variables.outputs.ghcr_image}}) | |
| uses: actions/attest-build-provenance@v2 | |
| if: env.GHCR_ENABLED == 'true' | |
| with: | |
| subject-name: ${{ needs.define-variables.outputs.ghcr_image}} | |
| subject-digest: ${{ steps.build.outputs.digest }} | |
| push-to-registry: true | |
| - name: Generate artifact attestation (index.${{ needs.define-variables.outputs.docker_image}}) | |
| uses: actions/attest-build-provenance@v2 | |
| if: (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') | |
| with: | |
| # see action readme (we need to use index.docker.io rather than docker.io) | |
| subject-name: index.${{ needs.define-variables.outputs.docker_image}} | |
| subject-digest: ${{ steps.build.outputs.digest }} | |
| push-to-registry: true | |
| - name: Generate artifact attestation (${{ needs.define-variables.outputs.glhr_image}}) | |
| uses: actions/attest-build-provenance@v2 | |
| if: (vars.GITLAB_USERNAME != '') && (env.GITLAB_TOKEN != '') | |
| with: | |
| subject-name: ${{ needs.define-variables.outputs.glhr_image}} | |
| subject-digest: ${{ steps.build.outputs.digest }} | |
| push-to-registry: true | |
| # For publishing multi-platform manifests | |
| - name: Export digest | |
| run: | | |
| mkdir -p /tmp/digests | |
| digest="${{ steps.build.outputs.digest }}" | |
| touch "/tmp/digests/${digest#sha256:}" | |
| - name: Upload digest | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: ${{matrix.tag_suffix || ''}}digests-${{ env.PLATFORM_PAIR }} | |
| path: /tmp/digests/* | |
| if-no-files-found: error | |
| retention-days: 1 | |
| merge: | |
| runs-on: ubuntu-latest | |
| needs: [define-variables, build-image] | |
| strategy: | |
| matrix: ${{ fromJSON(needs.define-variables.outputs.merge_matrix) }} | |
| steps: | |
| - name: Download digests | |
| uses: actions/download-artifact@v4 | |
| with: | |
| path: /tmp/digests | |
| pattern: ${{matrix.tag_suffix || ''}}digests-* | |
| merge-multiple: true | |
| # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here. | |
| - name: Login to GitHub Container Registry | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: ghcr.io | |
| username: ${{ github.actor }} | |
| password: ${{ secrets.GITHUB_TOKEN }} | |
| - name: Login to Docker Hub | |
| if: ${{ (vars.DOCKER_USERNAME != '') && (env.DOCKERHUB_TOKEN != '') }} | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: docker.io | |
| username: ${{ vars.DOCKER_USERNAME }} | |
| password: ${{ secrets.DOCKERHUB_TOKEN }} | |
| - name: Login to GitLab Container Registry | |
| if: ${{ (vars.GITLAB_USERNAME != '') && (env.GITLAB_TOKEN != '') }} | |
| uses: docker/login-action@v3 | |
| with: | |
| registry: registry.gitlab.com | |
| username: ${{ vars.GITLAB_USERNAME }} | |
| password: ${{ secrets.GITLAB_TOKEN }} | |
| - name: Set up Docker Buildx | |
| uses: docker/setup-buildx-action@v3 | |
| - name: Extract metadata (tags) for Docker | |
| id: meta | |
| uses: docker/metadata-action@v5 | |
| with: | |
| flavor: | | |
| suffix=-tiny${{ matrix.tag_suffix }} | |
| tags: | | |
| type=semver,pattern=v{{version}} | |
| type=semver,pattern=v{{major}}.{{minor}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.0.') }} | |
| type=semver,pattern=v{{major}},enable=${{ !startsWith(github.ref, 'refs/tags/v0.') }} | |
| type=ref,event=branch | |
| type=ref,event=pr | |
| type=sha,format=long,prefix={{branch}}- | |
| images: ${{needs.define-variables.outputs.images}} | |
| # default labels & annotations: https://github.com/docker/metadata-action/blob/master/src/meta.ts#L509 | |
| env: | |
| DOCKER_METADATA_ANNOTATIONS_LEVELS: index | |
| - name: Create manifest list and push | |
| working-directory: /tmp/digests | |
| env: | |
| IMAGES: ${{needs.define-variables.outputs.images}} | |
| run: | | |
| IFS=$'\n' | |
| IMAGES_LIST=($IMAGES) | |
| ANNOTATIONS_LIST=($DOCKER_METADATA_OUTPUT_ANNOTATIONS) | |
| TAGS_LIST=($DOCKER_METADATA_OUTPUT_TAGS) | |
| for REPO in "${IMAGES_LIST[@]}"; do | |
| docker buildx imagetools create \ | |
| $(for tag in "${TAGS_LIST[@]}"; do echo "--tag"; echo "$tag"; done) \ | |
| $(for annotation in "${ANNOTATIONS_LIST[@]}"; do echo "--annotation"; echo "$annotation"; done) \ | |
| $(for reference in *; do printf "$REPO@sha256:%s\n" $reference; done) | |
| done | |
| - name: Inspect image | |
| env: | |
| IMAGES: ${{needs.define-variables.outputs.images}} | |
| run: | | |
| IMAGES_LIST=($IMAGES) | |
| for REPO in "${IMAGES_LIST[@]}"; do | |
| docker buildx imagetools inspect $REPO:${{ steps.meta.outputs.version }} | |
| done |