From 4b3e94bb99b5b7b3a87785e94baaba7f8335b0d9 Mon Sep 17 00:00:00 2001
From: Shun Liang <shun.liang.public@gmail.com>
Date: Mon, 21 Oct 2024 18:19:34 +0100
Subject: [PATCH] Add github action to build and publish docker image

---
 .../workflows/docker-build-and-publish.yml    | 59 +++++++++++++++++++
 ...k_and_lint.yml => type-check-and-lint.yml} |  0
 README.md                                     |  1 -
 3 files changed, 59 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/docker-build-and-publish.yml
 rename .github/workflows/{type_check_and_lint.yml => type-check-and-lint.yml} (100%)

diff --git a/.github/workflows/docker-build-and-publish.yml b/.github/workflows/docker-build-and-publish.yml
new file mode 100644
index 0000000..f093524
--- /dev/null
+++ b/.github/workflows/docker-build-and-publish.yml
@@ -0,0 +1,59 @@
+name: Create and publish a Docker image
+
+on:
+  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:
+  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-action65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        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
+          platforms: linux/amd64,linux/arm64
+          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/.github/workflows/type_check_and_lint.yml b/.github/workflows/type-check-and-lint.yml
similarity index 100%
rename from .github/workflows/type_check_and_lint.yml
rename to .github/workflows/type-check-and-lint.yml
diff --git a/README.md b/README.md
index a2ea989..51e1dd7 100644
--- a/README.md
+++ b/README.md
@@ -146,5 +146,4 @@ List of available SaT models [here](https://github.com/segment-any-text/wtpsplit
 
 ## TODOs
 * Tests and evaluation
-* Better whisper prompting strategy (right now hugely depend on the title and the description of the video).
 * Better support for non-English languages