KEH-1221 - Add additional linters

[smstone0]

What type of PR is this? (check all applicable)

• Refactor
• Feature
• Bug Fix
• Optimization
• Documentation Update

What

Added Markdown linter and Megalinter for more general linting. Resolved linting errors across codebase.

Testing

Have any new tests been added as part of this issue? If not, try to explain why test coverage is not needed here.

• Yes
• No
  Please write a brief description of why test coverage is not necessary here.
• Not as part of this ticket. (Could be done at a later point)

Documentation

Has any new documentation been written as part of this issue? We should try to keep documentation up to date
as new code is added, rather than leaving it for the future.

• Yes
• No
  Please write a brief description of why documentation is not necessary here.
• Not as part of this ticket. (Could be done at a later point)

Related issues

KEH-1221

How to review

View GitHub Actions. Linting should pass.

[github-actions]

🦙 MegaLinter status: ❌ ERROR

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
⚠️ BASH	bash-exec	6		4	0.04s
✅ BASH	shellcheck	6		0	0.19s
✅ BASH	shfmt	6		0	0.02s
✅ DOCKERFILE	hadolint	1		0	0.1s
✅ JSON	jsonlint	1		0	0.3s
✅ JSON	prettier	1		0	0.6s
✅ JSON	v8r	1		0	2.18s
✅ MARKDOWN	markdownlint	5		0	0.9s
✅ REPOSITORY	checkov	yes		no	22.47s
✅ REPOSITORY	dustilock	yes		no	0.01s
❌ REPOSITORY	gitleaks	yes		4	6.42s
✅ REPOSITORY	grype	yes		no	24.26s
✅ REPOSITORY	kics	yes		no	51.88s
✅ REPOSITORY	secretlint	yes		no	0.83s
✅ REPOSITORY	syft	yes		no	4.38s
✅ REPOSITORY	trivy	yes		no	19.82s
✅ REPOSITORY	trivy-sbom	yes		no	0.27s
✅ TERRAFORM	terraform-fmt	6		0	0.57s
✅ YAML	prettier	8		0	1.18s
✅ YAML	v8r	8		0	10.35s
✅ YAML	yamllint	8		0	0.69s

See detailed report in MegaLinter reports

You could have the same capabilities but better runtime performances if you use a MegaLinter flavor:

• oxsecurity/megalinter/flavors/terraform@v8.3.0 (54 linters)
• oxsecurity/megalinter/flavors/cupcake@v8.3.0 (83 linters)

MegaLinter is graciously provided by OX Security

[TotalDwarf03]

Gitleaks linting will be addressed separately.

[TotalDwarf03]

I'll have another look at this conflict when I cover the gitleaks error.

Should be able to configure this so that it doesn't conflict.

[TotalDwarf03]

Looks good. Good work 👍

The Gitleaks linting fail and the markdown table linting can be dealt with in another ticket. Will pick it up while you're away.