chore: update release flow to be fully automated (#304)

Author: morremeyer

.github/actions/go-test/action.yml

@@ -0,0 +1,24 @@
+name: "go test"
+description: "runs go tests"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Check out repository
+      uses: actions/[email protected]
+
+    - name: Set up go
+      uses: actions/[email protected]
+      with:
+        # renovate: go-version
+        go-version: 1.18.4
+
+    - name: Run go tests
+      shell: bash
+      run: |
+        go test ./... -race -covermode=atomic -coverprofile=coverage.out
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v3
+      with:
+        files: coverage.out

.github/workflows/pre-commit.yml

@@ -1,18 +1,15 @@
 name: pre-commit
 
 on:
-  pull_request:
   push:
-    branches:
-      - main
 
 jobs:
   pre-commit:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/[email protected]
 
-      - uses: actions/setup-go@v3
+      - uses: actions/setup-go@v3.2.1
         with:
           # renovate: go-version
           go-version: 1.18.4

.github/workflows/go-test-and-release.yml renamed to .github/workflows/test-and-release.yml

@@ -1,54 +1,40 @@
-name: go test & release
+name: test & release
 
 on:
-  pull_request:
   push:
-    branches:
-      - main
     tags:
-      - "*"
+      - "v*"
 
 permissions:
   contents: write
   packages: write
 
 jobs:
-  go-test:
+  test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/[email protected]
-
-      - uses: actions/setup-go@v3
-        with:
-          # renovate: go-version
-          go-version: 1.18.4
+      - name: Check out repository
+        uses: actions/[email protected]
 
       - name: go test
-        run: |
-          go test -v ./... -race -covermode=atomic -coverprofile=coverage.out
-
-      - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v3
-        with:
-          files: coverage.out
+        uses: ./.github/actions/go-test
 
-  goreleaser:
+  release:
+    needs: test
     runs-on: ubuntu-latest
-    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
-    needs: go-test
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v3.0.2
         with:
           fetch-depth: 0
 
       - name: Set up Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v3.2.1
         with:
           # renovate: go-version
           go-version: 1.18.4
 
-      - uses: docker/login-action@v2
+      - uses: docker/login-action@v2.0.0
         with:
           registry: ghcr.io
           username: ${{ github.actor }}

.github/workflows/test-and-tag.yml

@@ -0,0 +1,37 @@
+name: test & tag
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/[email protected]
+
+      - name: go test
+        uses: ./.github/actions/go-test
+
+  tag:
+    runs-on: ubuntu-latest
+    needs: test
+    container: ghcr.io/caarlos0/svu
+    steps:
+      - name: Checkout
+        uses: actions/[email protected]
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.EZ_BOT_TOKEN }}
+
+      - name: Tag new version
+        run: |
+          if [ $(git tag -l "$(svu next)") ]; then
+            echo "Tag already exists, no release necessary"
+          else
+            echo "Tagging new version"
+            git tag "$(svu next)"
+            git push --tags
+          fi

.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: "test"
+
+on:
+  push:
+    branches-ignore:
+      - main
+    tags-ignore:
+      - "v*"
+
+  workflow_call:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/[email protected]
+
+      - name: go test
+        uses: ./.github/actions/go-test

.goreleaser.yaml

@@ -5,22 +5,40 @@ builds:
       - linux
       - windows
       - darwin
+    goarch:
+      - amd64
+      - arm64
     ldflags:
       - -X github.com/envelope-zero/backend/internal/router.version={{.Version}}
+
 archives:
   - replacements:
-      darwin: Darwin
-      linux: Linux
-      windows: Windows
-      386: i386
       amd64: x86_64
-checksum:
-  name_template: "checksums.txt"
+
 snapshot:
   name_template: "{{ incpatch .Version }}-next"
+
 changelog:
-  sort: asc
+  use: github
+  groups:
+    - title: Features
+      regexp: "^.*feat[(\\w)]*:+.*$"
+      order: 0
+
+    - title: "Bug fixes"
+      regexp: "^.*fix[(\\w)]*:+.*$"
+      order: 1
+
+    - title: Others
+      order: 2
+
+    - title: "Dependency updates"
+      regexp: "^.*chore(deps):+.*$"
+      order: 3
+
   filters:
+    # Commit messages matching the regexp listed here will be removed from
+    # the changelog
     exclude:
       - "^docs:"
       - "^test:"

CONTRIBUTING.md

@@ -33,6 +33,12 @@ Please do:
 - try to add tests for everything you add to the codebase. If you're unsure about how to test, please open a pull request and ask for input so we can work on it together!
 - add regression tests for bug fixes
 
+## Releases
+
+Releases are fully automated and happen on every feature and bug fix that is merged into the `main` branch.
+
+Maintainers can manually trigger the release of a new version by creating the corresponding tag and pushing it. This is used to release new versions that only contain updates of dependencies.
+
 ## Common errors
 
 ### pre-commit fails in GitHub action

Makefile

@@ -15,7 +15,7 @@ devserver:
 
 .PHONY: test
 test:
-	go test ./... -covermode=count -coverprofile=coverage.out -count=1
+	go test ./... -covermode=atomic -coverprofile=coverage.out -count=1
 
 .PHONY: coverage
 coverage: test

README.md

@@ -82,7 +82,7 @@ ingress:
 
 ## Supported Versions
 
-This project is under heavy development. Therefore, only the latest release is supported.
+As the backend is constantly developed, only the latest minor version is supported (versions are `MAJOR.MINOR.PATCH`). If you encounter an issue, please update to the latest version of the backend and verify that it still exists in that version.
 
 Please check the [releases page](https://github.com/envelope-zero/backend/releases) for the latest release.