From 15bf3d9135275920d54d30c0d46b88aed49ca3e4 Mon Sep 17 00:00:00 2001
From: Olly Ewert <olly@ewert.co.nz>
Date: Sun, 12 Jan 2025 12:15:00 +1300
Subject: [PATCH] add container image reference

---
 .github/workflows/build.yml | 56 +++++++++++++++++++++++++++++++++++++
 README.md                   |  6 ++++
 2 files changed, 62 insertions(+)
 create mode 100644 .github/workflows/build.yml

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
new file mode 100644
index 0000000..5e54568
--- /dev/null
+++ b/.github/workflows/build.yml
@@ -0,0 +1,56 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Publish Docker image
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  push_to_registry:
+    name: Push Docker image to Docker Hub
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+      attestations: write
+      id-token: write
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@f4ef78c080cd8ba55a85445d5b36e214a81df20a
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: my-docker-hub-namespace/my-docker-hub-repository
+
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@3b5e8027fcad23fda98b2e3ac259d8d67585f671
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v2
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true
diff --git a/README.md b/README.md
index f2236b9..b462339 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,12 @@ Errors and requests stats are added with the method and path labels - BE CAREFUL
 It is probably better to group the endpoints in your locustfile (please
 see: http://docs.locust.io/en/latest/writing-a-locustfile.html#grouping-requests-to-urls-with-dynamic-parameters).
 
+## Container Quickstart
+
+This project is available as a pre-built container image.
+
+    docker pull ghcr.io/ollytheninja/locust_exporter
+
 ## Setup
 
 This project uses [UV](https://docs.astral.sh/uv/).