Add megalinter and fix any issues

.github/workflows/mega-linter.yml

@@ -0,0 +1,52 @@
+# MegaLinter GitHub Action configuration file
+# More info at https://megalinter.io
+---
+name: MegaLinter
+
+# Trigger mega-linter at every push. Action will also be visible from
+# Pull Requests to main
+on:
+  pull_request:
+    branches:
+      - main
+
+env:
+  APPLY_FIXES: none
+  APPLY_FIXES_EVENT: pull_request
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+jobs:
+  megalinter:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+
+    # Give the default GITHUB_TOKEN write permission to comment the Megalinter output onto pull requests
+    # and read permission to the codebase
+    permissions:
+      contents: read
+      pull-requests: write
+
+    steps:
+      # Git Checkout
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+
+      # MegaLinter
+      - name: MegaLinter
+
+        # You can override MegaLinter flavor used to have faster performances
+        # More info at https://megalinter.io/latest/flavors/
+        uses: oxsecurity/megalinter@v8
+
+        id: ml
+
+        # All available variables are described in documentation
+        # https://megalinter.io/latest/config-file/
+        env:
+          VALIDATE_ALL_CODEBASE: true
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -2,4 +2,5 @@
 *.iml
 target/*
 .java-version
-.DS_Store
+.DS_Store
+megalinter-reports/

.markdownlint.yaml

@@ -0,0 +1,6 @@
+# markdownlint YAML configuration
+
+# MD024/no-duplicate-heading/no-duplicate-header - Multiple headings with the same content
+MD024:
+  # Only check sibling headings
+  siblings_only: true

.mega-linter.yml

@@ -0,0 +1,15 @@
+# Configuration file for MegaLinter
+#
+# See all available variables at https://megalinter.io/latest/config-file/ and in
+# linters documentation
+
+# all, none, or list of linter keys
+APPLY_FIXES: none
+
+# If you use ENABLE_LINTERS variable, all other linters will be disabled by
+# default
+ENABLE_LINTERS:
+  - MARKDOWN_MARKDOWNLINT
+
+# Ignore the pull request template
+FILTER_REGEX_EXCLUDE: .github/PULL_REQUEST_TEMPLATE.md

Makefile

@@ -22,3 +22,21 @@ test:
 
 docker-build:
 	docker build . -t europe-west2-docker.pkg.dev/ssdc-rm-ci/docker/ssdc-rh-service:latest
+
+megalint:  ## Run the mega-linter.
+	docker run --platform linux/amd64 --rm \
+		-v /var/run/docker.sock:/var/run/docker.sock:rw \
+		-v $(shell pwd):/tmp/lint:rw \
+		oxsecurity/megalinter:v8
+
+megalint-fix:  ## Run the mega-linter and attempt to auto fix any issues.
+	docker run --platform linux/amd64 --rm \
+		-v /var/run/docker.sock:/var/run/docker.sock:rw \
+		-v $(shell pwd):/tmp/lint:rw \
+		-e APPLY_FIXES=all \
+		oxsecurity/megalinter:v8
+
+clean-megalint: ## Clean the temporary files.
+	rm -rf megalinter-reports
+
+lint-check: clean_megalint megalint

README.md

@@ -30,7 +30,7 @@ make format
 ## Locally Running and Debugging
 
 The easiest way to run the RH service is dockerised, with our full stack services locally by following the README
-in [ssdc-rm-docker-dev](#TODO).
+in [ssdc-rm-docker-dev](https://github.com/ONSdigital/ssdc-rm-docker-dev).
 
 If you need to run the service locally in the IDE or from the command line (e.g. with local code changes or to debug),
 use docker-dev to start the RM services, and