Include Rubocop in CI (#292)

Author: anttiharju

.github/actions/keep-generic/action.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env sh
+set -eu
+repo_root="$(git rev-parse --show-toplevel)"
+cd "$repo_root" || exit 1
+
+repo_name="$(basename "$repo_root")"
+forbidden=$(git grep -n "$repo_name" -- ':!internal/' ':!docs/' ':!go.mod' ':!main.go' ':!mkdocs.yml' || true)
+if [ -n "$forbidden" ]; then
+    echo "ERROR: Found references to '$repo_name' outside of internal/ or docs/ directories:"
+    echo "$forbidden"
+    exit 1
+fi

.github/actions/keep-generic/action.yml

@@ -0,0 +1,10 @@
+name: "Keep generic"
+description: "Fail if repo name is hardcoded somewhere its not supposed to."
+
+runs:
+  using: "composite"
+  steps:
+    - name: Keep generic
+      shell: sh
+      run: |
+        "$GITHUB_ACTION_PATH/action.sh"

.github/actions/rubocop-formula/action.yml

@@ -0,0 +1,15 @@
+name: "Rubocop formula"
+description: "Run rubocop on the render formula"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Render out final formula
+      shell: sh
+      env:
+        GH_TOKEN: ${{ github.token }}
+      run: |
+        ./dist/brew/render.bash
+    - uses: anttiharju/actions/rubocop-file@v1
+      with:
+        file: "dist/brew/.${{ github.event.repository.name }}.rb"

.github/workflows/plan.yml

@@ -68,20 +68,28 @@ jobs:
         name: golangci-lint
         uses: anttiharju/actions/golangci-lint@v1
 
-      - if: always() && (steps.changed.outputs.documentation == 'true' || github.event_name != 'pull_request')
-        name: MkDocs
-        uses: anttiharju/actions/mkdocs-build-strict@v1
+      - if: always()
+        name: Keep generic
+        uses: ./.github/actions/keep-generic
 
       - if: always()
-        name: keep-yml
+        name: Keep .yml
         uses: anttiharju/actions/keep-yml@v1
 
+      - if: always() && (steps.changed.outputs.documentation == 'true' || github.event_name != 'pull_request')
+        name: MkDocs
+        uses: anttiharju/actions/mkdocs-build-strict@v1
+
       - if: always() && (steps.changed.outputs.md_and_yml == 'true' || github.event_name != 'pull_request')
         name: Prettier
         uses: anttiharju/actions/prettier@v1
         with:
           patterns: "{*.yml,*.md}"
 
+      - if: always() && (steps.changed.outputs.dist_brew == 'true' || github.event_name != 'pull_request')
+        name: Rubocop formula
+        uses: ./.github/actions/rubocop-formula
+
       - if: always() && (steps.changed.outputs.scripts == 'true' || github.event_name != 'pull_request')
         name: ShellCheck
         uses: anttiharju/actions/shellcheck@v1

.gitignore

@@ -49,3 +49,6 @@ dist/brew/*.rb
 
 # Packaging happens under this directory
 tmp
+
+# rubocop-file action
+/*.lock

dist/brew/render.bash

@@ -32,14 +32,15 @@ if [[ "$quick_mode" == true ]] && [[ -f "$cache_file" ]]; then
 else
   echo "Generating fresh values"
 
-  # Only download binaries if the tag has changed or cache doesn't exist
-  if [[ "$cached_tag" != "$TAG" ]]; then
-    echo "New release detected: $TAG (was: ${cached_tag:-none})"
-    gh release download "$TAG" --pattern "$repo_name-*64.tar.gz"
+  if [[ "$cached_tag" != "$TAG" ]] || [[ -z "$TAG" ]]; then
+    echo "New release detected: ${TAG:-empty} (was: ${cached_tag:-none})"
+    gh release download --pattern "$repo_name-*64.tar.gz"
     find . -name "$repo_name-*64.tar.gz" -exec mv {} "$repo_root/" \;
 
-    # Cache the latest tag
-    echo "$TAG" > "$tag_cache_file"
+    # Cache the latest tag only if it's not empty
+    if [[ -n "$TAG" ]]; then
+      echo "$TAG" > "$tag_cache_file"
+    fi
   else
     echo "Using cached binaries for tag: $TAG"
   fi

lefthook.yml

@@ -33,24 +33,17 @@ pre-commit:
       run: golangci-lint run --fix
       stage_fixed: true
 
-    - name: MkDocs
-      glob: "{docs/*,mkdocs.yml}"
-      run: mkdocs build --strict
-
     - name: Keep generic
-      run: |
-        repo_name="$(basename "$(pwd)")"
-        forbidden=$(git grep -l "$repo_name" -- ':!internal/' ':!docs/' ':!go.mod' ':!main.go' ':!mkdocs.yml' || true)
-        if [ -n "$forbidden" ]; then
-          echo "ERROR: Found references to '$repo_name' outside of internal/ or docs/ directories:"
-          echo "$forbidden"
-          exit 1
-        fi
+      run: ./.github/actions/keep-generic/action.sh
 
     - name: Keep .yml
       glob: "*.yaml"
       run: echo "You are trying to commit .yaml files. Please use .yml instead for the following files:" && echo {staged_files} && exit 1
 
+    - name: MkDocs
+      glob: "{docs/*,mkdocs.yml}"
+      run: mkdocs build --strict
+
     - name: Prettier
       glob: "{*.yml,*.md}"
       run: prettier --write {staged_files}