Detect secrets, minor linting, and CODEOWNERS (#4)

* make arc-environments code owners

* pre-commit for cursory linting and secrets

.github/.secrets.baseline

@@ -0,0 +1,112 @@
+{
+  "version": "1.4.0",
+  "plugins_used": [
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "name": "Base64HighEntropyString",
+      "limit": 4.5
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "name": "DiscordBotTokenDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "name": "HexHighEntropyString",
+      "limit": 3.0
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "name": "KeywordDetector",
+      "keyword_exclude": ""
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "SendGridDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "filters_used": [
+    {
+      "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
+    },
+    {
+      "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
+      "min_level": 2
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_indirect_reference"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_likely_id_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_lock_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_potential_uuid"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_sequential_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_swagger_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_templated_secret"
+    }
+  ],
+  "results": {},
+  "generated_at": "2024-01-30T09:43:18Z"
+}

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Default owners of everything in the repo.
+* @UCL-ARC/arc-environments

.github/workflows/build_mkdocs.yml

@@ -15,17 +15,17 @@ jobs:
       - uses: actions/[email protected]
         with:
           fetch-depth: '0'
-        
+
       - name: Set up Python
         uses: actions/[email protected]
         with:
           python-version: "3.10"
-      
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-       
-      - name: Run a command 
+
+      - name: Run a command
         run: |
           mkdocs build

.github/workflows/pre-commit.yml

@@ -0,0 +1,27 @@
+---
+    name: Lint
+
+    on:
+      pull_request:
+      push:
+        branches:
+          - "main"
+          - "renovate/**"
+
+    jobs:
+      pre-commit:
+        runs-on: ubuntu-latest
+
+        steps:
+          - name: Checkout repository
+            uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+          - name: Setup Python
+            uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
+            with:
+              python-version: "3.11"
+
+          - name: Run pre-commit
+            uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1
+            with:
+              extra_args: --all-files

.gitignore

@@ -4,4 +4,4 @@
 # ignore the built site
 /site**
 
-.DS_Store
+.DS_Store

.markdownlint.json

@@ -2,4 +2,4 @@
     "MD025": {"front_matter_title": ""},
     "MD007": {"indent": 4},
     "MD024": {"siblings_only": true}
-}
+}

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+      - id: trailing-whitespace
+
+  - repo: https://github.com/Yelp/detect-secrets
+    rev: v1.5.0
+    hooks:
+      - id: detect-secrets
+        args: ['--baseline', '.github/.secrets.baseline']

mkdocs.yml

@@ -16,4 +16,4 @@ markdown_extensions:
   - admonition
   - pymdownx.highlight:
       anchor_linenums: true
-  - pymdownx.superfences
+  - pymdownx.superfences

requirements.txt

@@ -1,2 +1,2 @@
 mkdocs-material
-mkdocs-git-revision-date-localized-plugin
+mkdocs-git-revision-date-localized-plugin