build: improve compression and update GitHub actions (#168)

- Add `dist` to .gitignore for gorelease binary folder
- Replace tar command with xz command in .goreleaser.yaml for better compression

ref: https://gitea.com/gitea/homebrew-gitea/pulls/164

Signed-off-by: appleboy <appleboy.tw@gmail.com>

Reviewed-on: https://gitea.com/gitea/act_runner/pulls/168
Reviewed-by: techknowlogick <techknowlogick@noreply.gitea.io>
Co-authored-by: appleboy <appleboy.tw@gmail.com>
Co-committed-by: appleboy <appleboy.tw@gmail.com>

.gitea/workflows/release-nightly.yml

@@ -58,6 +58,11 @@ jobs:
         with:
           fetch-depth: 0 # all history for all branches and tags
 
+      - name: dockerfile lint check
+        uses: https://github.com/hadolint/hadolint-action@v3.1.0
+        with:
+          dockerfile: Dockerfile
+
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2
 

.gitea/workflows/release-tag.yml

@@ -1,6 +1,6 @@
 name: release-tag
 
-on: 
+on:
   push:
     tags:
       - '*'
@@ -69,6 +69,11 @@ jobs:
         with:
           fetch-depth: 0 # all history for all branches and tags
 
+      - name: dockerfile lint check
+        uses: https://github.com/hadolint/hadolint-action@v3.1.0
+        with:
+          dockerfile: Dockerfile
+
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2
 

.gitea/workflows/test.yml

@@ -1,5 +1,5 @@
 name: checks
-on: 
+on:
   - push
   - pull_request
 
@@ -36,3 +36,7 @@ jobs:
         run: make build
       - name: test
         run: make test
+      - name: dockerfile lint check
+        uses: https://github.com/hadolint/hadolint-action@v3.1.0
+        with:
+          dockerfile: Dockerfile

.gitignore

@@ -8,3 +8,5 @@ coverage.txt
 # MS VSCode
 .vscode
 __debug_bin
+# gorelease binary folder
+dist

.goreleaser.yaml

@@ -71,10 +71,8 @@ builds:
   no_unique_dist_dir: true
   hooks:
     post:
-      - cmd: tar -cJf {{ .Path }}.xz {{ .Path }}
+      - cmd: xz -k -9 {{ .Path }}
         dir: ./dist/
-        env:
-          - XZ_OPT=-9
       - cmd: sh .goreleaser.checksum.sh {{ .Path }}
       - cmd: sh .goreleaser.checksum.sh {{ .Path }}.xz
 

Dockerfile

@@ -1,15 +1,15 @@
-FROM golang:alpine as builder
+FROM golang:1.20-alpine3.17 as builder
-RUN apk add --update-cache make git
+RUN apk add --no-cache make=4.3-r1 git=2.38.5-r0
 
 COPY . /opt/src/act_runner
 WORKDIR /opt/src/act_runner
 
 RUN make clean && make build
 
-FROM alpine as runner
+FROM alpine:3.17
-RUN apk add --update-cache \
+RUN apk add --no-cache \
-    git bash \
+  git=2.38.5-r0 bash=5.2.15-r0 \
-    && rm -rf /var/cache/apk/*
+  && rm -rf /var/cache/apk/*
 
 COPY --from=builder /opt/src/act_runner/act_runner /usr/local/bin/act_runner
 COPY run.sh /opt/act/run.sh

README.md

@@ -91,5 +91,29 @@ You can specify the configuration file path with `-c`/`--config` argument.
 ### Run a docker container
 
 ```sh
-docker run -e GITEA_INSTANCE_URL=http://192.168.8.18:3000 -e GITEA_RUNNER_REGISTRATION_TOKEN=<runner_token> -v /var/run/docker.sock:/var/run/docker.sock --name my_runner gitea/act_runner:nightly
+docker run -e GITEA_INSTANCE_URL=http://192.168.8.18:3000 -e GITEA_RUNNER_REGISTRATION_TOKEN=<runner_token> -v /var/run/docker.sock:/var/run/docker.sock -v $PWD/data:/data --name my_runner gitea/act_runner:nightly
+```
+
+The `/data` directory inside the docker container contains the runner API keys after registration.
+It must be persisted, otherwise the runner would try to register again, using the same, now defunct registration token.
+
+### Running in docker-compose
+
+```yml
+...
+  gitea:
+    image: gitea/gitea
+    ...
+
+  runner:
+    image: gitea/act_runner
+    restart: always
+    depends_on:
+      - gitea
+    volumes:
+      - ./data/act_runner:/data
+      - /var/run/docker.sock:/var/run/docker.sock
+    environment:
+      - GITEA_INSTANCE_URL=<instance url>
+      - GITEA_RUNNER_REGISTRATION_TOKEN=<registration token>
 ```