Remove no-longer-useful linters, scripts etc.

Keep the terraform fmt check (still helps fight entropy) and the YAML lint (not sure it's doing much any more but it's fast and self-contained so no reason to delete it). Ditch the Ruby stuff because it's no longer checking anything important and it generates maintenance overhead with all the dependency updates. Especially ditch the terraform-docs check - it's of negative value at this point.
alphagov · Feb 2, 2024 · 819dbe1 · 819dbe1
1 parent d1d7ebf
commit 819dbe1
Show file tree

Hide file tree

Showing 18 changed files with 2 additions and 925 deletions.
diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml
@@ -15,29 +15,6 @@ on:
   pull_request:
 
 jobs:
-  check-docs:
-    name: Docs up to date
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          show-progress: false
-      - name: terraform-docs
-        env:
-          TERRAFORM_DOCS_VERSION: '0.16.0'
-        run: |
-          echo "Downloading terraform-docs-v${TERRAFORM_DOCS_VERSION} binary."
-          curl -Lsf \
-            "https://github.com/terraform-docs/terraform-docs/releases/download/v${TERRAFORM_DOCS_VERSION}/terraform-docs-v${TERRAFORM_DOCS_VERSION}-linux-amd64.tar.gz" | tar -zxf - terraform-docs
-
-          echo "Checking whether auto-generated README files are up to date."
-          PATH="$PATH:$PWD" tools/update-docs.sh
-
-          if ! git diff --exit-code; then
-            echo "The documentation isn't up to date. Run tools/update-docs.sh and commit the results."
-            exit 1
-          fi
-
   shellcheck:
     name: Shellcheck
     runs-on: ubuntu-latest
@@ -61,6 +38,8 @@ jobs:
         with:
           path: ~/tfenv
           key: tfenv-${{ runner.os }}
+      - name: Validate JSON
+        run: find . -type -f -name '*.json' | xargs tools/json-check.sh
       - name: terraform install
         env:
           TFENV_VERSION: '3.0.0'
@@ -89,27 +68,3 @@ jobs:
             echo "Run terraform fmt -recursive . to fix formatting."
             exit 1
           fi
-
-  other-linters:
-    name: Other linters
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          show-progress: false
-      - uses: ruby/setup-ruby@v1
-      - uses: actions/cache@v3
-        with:
-          path: vendor/bundle
-          key: bundle-${{ hashFiles('**/Gemfile.lock') }}
-          restore-keys: bundle
-      - name: bundle install
-        run: bundle install -j8 --deployment --without development
-      - name: RSpec
-        run: bundle exec rspec spec/validate_resources_spec.rb
-      - name: Lint resource names
-        run: bundle exec lib/resource_name_lint.rb
-      - name: Validate JSON
-        run: find . -type -f -name '*.json' | xargs tools/json-check.sh
-      - name: Check ADRs
-        run: tools/adr-check.sh
diff --git a/.ruby-version b/.ruby-version
diff --git a/Gemfile b/Gemfile
diff --git a/Gemfile.lock b/Gemfile.lock
diff --git a/jenkins.sh b/jenkins.sh
diff --git a/lib/resource_name_lint.rb b/lib/resource_name_lint.rb
diff --git a/lib/validate_resources.rb b/lib/validate_resources.rb
diff --git a/lint.yaml b/lint.yaml
diff --git a/spec/aws_security_group_rule.tf b/spec/aws_security_group_rule.tf
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
diff --git a/spec/validate_resources_spec.rb b/spec/validate_resources_spec.rb
diff --git a/tools/adr-check.sh b/tools/adr-check.sh