adds docker-compose.yml for local example (#13)

Signed-off-by: Jan Akerman <[email protected]>

Author: janakerman

README.md

@@ -69,6 +69,18 @@ docker run -d -p 9101:9101 ghcr.io/cpanato/github_actions_exporter-linux-amd64:v
 make test
 ```
 
+### Manual testing
+
+```bash
+cd example/
+export WEBHOOK_SECRET="..."
+export GITHUB_TOKEN="..."
+export GITHUB_ORG="..."
+docker-compose up --build
+```
+
+Open Prometheus at http://localhost:9090 and explore the available metrics.
+
 ## Contributing
 
 Refer to [CONTRIBUTING.md](https://github.com/cpanato/github_actions_exporter/blob/master/CONTRIBUTING.md).

example/Dockerfile.dev

@@ -0,0 +1,17 @@
+FROM golang:1.17-alpine as builder
+
+ARG GOARCH="amd64"
+ARG GOOS="linux"
+
+WORKDIR /code
+COPY . .
+
+RUN go build -o github-actions-exporter .
+
+FROM ghcr.io/distroless/busybox:latest
+
+COPY --from=builder /code/github-actions-exporter /bin/github-actions-exporter
+
+USER nobody
+ENTRYPOINT ["/bin/github-actions-exporter"]
+EXPOSE     9101

example/docker-compose.yml

@@ -0,0 +1,24 @@
+version: '3.8'
+
+services:
+  github-actions-exporter:
+    build:
+      context: ..
+      dockerfile: example/Dockerfile.dev
+    command:
+      - "--gh.github-webhook-token=$WEBHOOK_SECRET"
+      - "--gh.github-api-token=$GITHUB_TOKEN"
+      - "--gh.github-org=$GITHUB_ORG"
+    ports:
+      - 9101:9101
+    expose:
+      - 9101
+
+  prometheus:
+    image: prom/prometheus:v2.34.0
+    volumes:
+      - ./prometheus.yml:/etc/prometheus/prometheus.yml
+    command:
+      - '--config.file=/etc/prometheus/prometheus.yml'
+    ports:
+      - 9090:9090

example/prometheus.yml

@@ -0,0 +1,12 @@
+global:
+  scrape_interval:     15s
+
+scrape_configs:
+  - job_name: "prometheus"
+    scrape_interval: 5s
+    static_configs:
+    - targets: ["localhost:9090"]
+
+  - job_name: "github-actions-exporter"
+    static_configs:
+    - targets: ["github-actions-exporter:9101"]