Merge pull request saltstack#3 from scriptautomate-bc/devcontainer-contrib-updates

Add devcontainer and enable GHA

Author: scriptautomate-bc

.devcontainer/Dockerfile

@@ -0,0 +1,8 @@
+FROM bitnami/python:3.13
+
+RUN apt update && apt upgrade -y
+
+# Add dev requirements
+ADD requirements.txt /tmp/
+RUN pip3 install -r /tmp/requirements.txt
+RUN rm /tmp/requirements.txt

.devcontainer/devcontainer.json

@@ -0,0 +1,49 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+{
+	"name": "salt-user-guide",
+
+	// README at: https://github.com/devcontainers/templates/tree/main/src/python
+	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
+	// Python container image is needed for running python-based tests (ex. orphaned-content.py)
+	// "image": "mcr.microsoft.com/devcontainers/python:3.13-bookworm",
+
+	"build": {
+		"dockerfile": "Dockerfile"
+	},
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	// "features": {
+		// node / npm is required for markdownlint-cli2
+		// By default, installs lts version
+		// "ghcr.io/devcontainers/features/node:1": {}
+	// },
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	// "postCreateCommand": ""
+
+	// There is also a postStartCommand that executes every time the container starts.
+	// The parameters behave exactly like postCreateCommand, but the commands execute on start rather than create.
+	// "postStartCommand": ""
+
+	// There is also a postAttachCommand that executes every time the container attaches to a workspace.
+	// The parameters behave exactly like postCreateCommand, but the commands execute on a started container after the workspace is available under /workspaces/
+	// "postAttachCommand": {},
+
+	// Configure tool-specific properties.
+	"customizations": {
+		// Configure properties specific to VS Code.
+		"vscode": {
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				// Extension to work with Python
+				"ms-python.python"
+			]
+		}
+	}
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

requirements-dev.txt renamed to .devcontainer/requirements.txt

@@ -0,0 +1,85 @@
+# Workflow for building a Sphinx site and deploying artifacts to GitHub Releases
+name: Build Sphinx docs
+
+on:
+  push: {}
+  pull_request: {}
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Default to bash
+defaults:
+  run:
+    shell: bash
+
+jobs:
+
+  build:
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+          cache: pip
+      - name: Run pre-commit
+        run: |
+          pip install -U pip setuptools wheel
+          pip install -r .devcontainer/requirements.txt
+          pre-commit install
+          pre-commit run -a -v --color always
+      - name: Build docs
+        run: |
+          nox -e 'docs-html(gen_sitevars=True, clean=True)'
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: salt-user-guide
+          path: ./docs/_build/html/
+          if-no-files-found: error
+          retention-days: 1
+
+  # Release job
+  deploy:
+    permissions:
+      contents: write
+    runs-on: ubuntu-24.04
+    needs:
+      - build
+    if: success() && startsWith(github.ref, 'refs/tags/')
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+      - name: Display all downloaded archives/artifacts
+        run: |
+          ls -lah
+
+          echo "
+          Listing salt-user-guide/*..."
+          ls -lah salt-user-guide/*
+
+          echo "
+          Creating archive of built salt-user-guide..."
+          tar cvfz salt-user-guide.tar.gz salt-user-guide
+
+          echo "
+          Creating checksums.txt..."
+          sha512sum salt-user-guide.tar.gz salt.repo salt.sources | tee checksums.txt
+
+      - name: Release
+        uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda
+        with:
+          files: |
+            checksums.txt
+            salt-user-guide.tar.gz

.github/workflows/build-sphinx-docs.yml

@@ -1,8 +1,8 @@
 ---
-minimum_pre_commit_version: 2.9.3
+minimum_pre_commit_version: 4.2.0
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.0.1
+    rev: v5.0.0
     hooks:
       - id: check-merge-conflict
         description: Check for files that contain merge conflict strings.
@@ -29,19 +29,19 @@ repos:
           You must provide list of target files as input in your .pre-commit-config.yaml file.
         files: ^(.*requirements.*\.txt|\.brokignore|sitevars.rst)$
   - repo: https://github.com/timothycrosley/isort
-    rev: "5.11.5"
+    rev: "6.0.1"
     hooks:
       - id: isort
         description: isort is a Python utility / library to sort imports automatically.
         files: ^((noxfile|conf)|docs/_includes/python/.*)\.py$
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 25.1.0
     hooks:
       - id: black
         description: Forces best practice formatting of Python code files.
         files: ^((noxfile|conf)|docs/_includes/python/.*)\.py$
   - repo: https://github.com/myint/rstcheck
-    rev: 3f92957 # Latest as of 05/17/2020
+    rev: v6.2.4 # Latest as of 05/17/2020
     hooks:
       - id: rstcheck
         description: Checks syntax of reStructuredText/rst and code blocks nested within it.
@@ -50,12 +50,12 @@ repos:
         files: ^(index|docs/.*|docs/_includes/.*|README|CONTRIBUTING)\.rst$
         exclude: docs/topics/pillar.rst
   - repo: https://github.com/asottile/blacken-docs
-    rev: v1.10.0
+    rev: 1.19.1
     hooks:
       - id: blacken-docs
         description: Run black on python code blocks in documentation files.
         files: ^(index|docs/.*|docs/_includes/.*)\.rst$
-        additional_dependencies: [black==21.8b0]
+        additional_dependencies: [black==25.1.0]
 #  - repo: local
 #    hooks:
 #      - id: vendir
@@ -72,7 +72,7 @@ repos:
 #        language: system
 #        files: ^(index|docs/.*|docs/_includes/.*|README|CONTRIBUTING)\.rst$
   - repo: https://github.com/saltstack/mirrors-nox
-    rev: v2022.8.7
+    rev: v2022.11.21
     hooks:
       - id: nox
         alias: Generate Sphinx docs

.gitlab-ci.yml

@@ -11,4 +11,3 @@ ignore_directives=
   tab-set,
 ignore_substitutions=
   release,
-ignore_messages=(.*(aix|arista)\.rst.* \(ERROR\/3\) Error in "code-block" directive\:$)