From 17438c85c83fabc416841bac4864e07d092bf52e Mon Sep 17 00:00:00 2001 From: Bart Schilperoort Date: Fri, 30 Aug 2024 15:28:37 +0200 Subject: [PATCH 1/3] Add container building+publishing action --- .github/workflows/publish-container.yml | 58 +++++++++++++++++++++++++ Dockerfile | 7 +-- 2 files changed, 62 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/publish-container.yml diff --git a/.github/workflows/publish-container.yml b/.github/workflows/publish-container.yml new file mode 100644 index 00000000..1122e3b4 --- /dev/null +++ b/.github/workflows/publish-container.yml @@ -0,0 +1,58 @@ +# +name: Create and publish a Docker image + +on: + push: + branches: ['main'] + +# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds. +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu. +jobs: + build-and-push-image: + runs-on: ubuntu-latest + # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job. + permissions: + contents: read + packages: write + attestations: write + id-token: write + # + steps: + - name: Checkout repository + uses: actions/checkout@v4 + # 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: Log in to the Container registry + uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_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 (tags, labels) for Docker + id: meta + uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + # 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. + - name: Build and push Docker image + id: push + uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4 + with: + context: . + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + + # 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 "[AUTOTITLE](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds)." + - name: Generate artifact attestation + uses: actions/attest-build-provenance@v1 + with: + subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}} + subject-digest: ${{ steps.push.outputs.digest }} + push-to-registry: true diff --git a/Dockerfile b/Dockerfile index ca8b3929..8db1e3f5 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,8 +1,9 @@ FROM demartis/matlab-runtime:R2023a@sha256:9d6b3acd29b974ca0a0c77eca09a34488dcece290c8a4bd04dafaa7c4a5665b2 LABEL maintainer="Bart Schilperoort " -LABEL org.opencontainers.image.source = "https://github.com/EcoExtreML/STEMMUS_SCOPE" +LABEL org.opencontainers.image.source="https://github.com/EcoExtreML/STEMMUS_SCOPE" -RUN wget https://github.com/EcoExtreML/STEMMUS_SCOPE/raw/main/run_model_on_snellius/exe/STEMMUS_SCOPE --no-check-certificate +#RUN wget https://github.com/EcoExtreML/STEMMUS_SCOPE/raw/main/run_model_on_snellius/exe/STEMMUS_SCOPE --no-check-certificate +COPY run_model_on_snellius/exe/STEMMUS_SCOPE ./STEMMUS_SCOPE # Make sure the file is executable RUN chmod +x ./STEMMUS_SCOPE @@ -10,7 +11,7 @@ RUN chmod +x ./STEMMUS_SCOPE # Allow MCR to have a cache directory which all users can access RUN mkdir /temp/ RUN chmod 777 /temp/ -ENV MCR_CACHE_ROOT /temp/ +ENV MCR_CACHE_ROOT=/temp/ CMD ./STEMMUS_SCOPE "" bmi # Build the image with: `docker build . -t stemmus_scope` From fc506a3a0f2ea9d381882e9b420b207a7342cc0c Mon Sep 17 00:00:00 2001 From: Bart Schilperoort Date: Fri, 30 Aug 2024 15:30:17 +0200 Subject: [PATCH 2/3] Publish container upon release --- .github/workflows/publish-container.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish-container.yml b/.github/workflows/publish-container.yml index 1122e3b4..6ac638aa 100644 --- a/.github/workflows/publish-container.yml +++ b/.github/workflows/publish-container.yml @@ -2,8 +2,8 @@ name: Create and publish a Docker image on: - push: - branches: ['main'] + release: + types: [published] # Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds. env: From 63add361488b3082b80d66ef7a9445d0b8c67d79 Mon Sep 17 00:00:00 2001 From: Bart Schilperoort Date: Fri, 30 Aug 2024 15:31:31 +0200 Subject: [PATCH 3/3] Rename action --- .github/workflows/publish-container.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/publish-container.yml b/.github/workflows/publish-container.yml index 6ac638aa..2ec15fe2 100644 --- a/.github/workflows/publish-container.yml +++ b/.github/workflows/publish-container.yml @@ -1,5 +1,5 @@ # -name: Create and publish a Docker image +name: Create and publish the STEMMUS_SCOPE container image 📦 on: release: