chore: pre-commit updates (#1665)

Add a workflow that runs the pre-commit jobs to
cover the case where a developer hasn't opted into
pre-commit. Also add the conventional commit message
hook and enable more golang linters. The commits also
tidies up the markdown files that had line length
issues.

Signed-off-by: Maryam Tahhan <[email protected]>

.commitlintrc.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-conventional'] };

.github/workflows/pre-commit.yml

@@ -0,0 +1,12 @@
+name: pre-commit
+
+on: # yamllint disable-line rule:truthy
+  pull_request:
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+      - uses: pre-commit/[email protected]

.pre-commit-config.yaml

@@ -31,4 +31,10 @@ repos:
     rev: v1.59.1
     hooks:
       - id: golangci-lint
+  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
+    rev: v9.16.0
+    hooks:
+      - id: commitlint
+        stages: [commit-msg]
+        additional_dependencies: ['@commitlint/config-conventional']  # yamllint disable-line rule:quoted-strings
 exclude: ^vendor/.*|^_output/.*|^bpf/include/.*|^local-dev-cluster/.*

e2e/tools/validator/README.md

@@ -30,7 +30,8 @@ pip install .
 
 - Configure and Generate `validator.yaml` file
 
-  - Create the `validator.yaml` file based on the [validator.yaml.sample](validator.yaml.sample) template provided.
+  - Create the `validator.yaml` file based on the
+  [validator.yaml.sample](validator.yaml.sample) template provided.
   - Adjust the configuration according to your environment and requirements.
 
 - Run the validator

manifests/compose/validation/README.md

@@ -32,7 +32,8 @@ target deploys the following
 
 ### Usage
 
-To allow access to the VM from the Prometheus container running on the host, `virt-net` must be created using the following command:
+To allow access to the VM from the Prometheus container running on the host,
+`virt-net` must be created using the following command:
 
 - Check the Virtual Bridge Interface:
 
@@ -44,15 +45,17 @@ To allow access to the VM from the Prometheus container running on the host, `vi
 
 - Create the Docker Network:
 
-Use the `inet` address from the previous step to create the Docker Network with `macvlan` driver. Replace `<subnet>` with appropriate value.
+Use the `inet` address from the previous step to create the Docker Network with
+`macvlan` driver. Replace `<subnet>` with appropriate value.
 
 ```sh
 docker network create --driver=macvlan --subnet=<subnet>/24 -o parent=virbr0 virt-net
 ```
 
 - Start the Services:
 
-Navigate to appropriate directory, set the `VM_IP` environment variable, and bring up the services:
+Navigate to appropriate directory, set the `VM_IP` environment variable, and bring
+up the services:
 
 ```sh
 cd manifests/compose/validation/metal

manifests/compose/validation/dockerfiles/Dockerfile.scaphandre

@@ -3,4 +3,3 @@ FROM hubblo/scaphandre:latest
 
 # Install only curl
 RUN apt-get update && apt-get install -y curl
-