Merge pull request #16 from ScriptAutomate/enable-gha

Enable GitHub Actions (GHA) Baseline

Author: ScriptAutomate

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

@@ -0,0 +1,91 @@
+# 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-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+          cache: pip
+      - name: Run pre-commit
+        run: |
+          pip install -U pip setuptools wheel
+          pip install -r requirements-dev.txt
+          pre-commit install
+          pre-commit run -a -v --color always
+      - name: Build docs
+        run: |
+          nox -e 'docs-html(download_versions=True, clean=True)'
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: salt-install-guide
+          path: ./docs/_build/html/
+          if-no-files-found: error
+          retention-days: 1
+
+  # Release job
+  deploy:
+    permissions:
+      contents: write
+    environment:
+      name: release
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs:
+      - build
+    if: success() && github.ref == 'refs/heads/main'
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Display all downloaded archives/artifacts
+        run: |
+          ls -lah
+
+          echo "
+          Listing salt-install-guide/*..."
+          ls -lah salt-install-guide/*
+
+          echo "
+          Creating archive of built salt-install-guide..."
+          tar cvfz salt-install-guide.tar.gz salt-install-guide
+
+          echo "
+          Creating checksums.txt..."
+          sha512sum salt-install-guide.tar.gz salt.repo salt.sources > tee checksums.txt
+
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        if: startsWith(github.ref, 'refs/tags/')
+        with:
+          files: |
+            checksums.txt
+            salt.repo
+            salt.sources
+            salt-install-guide.tar.gz

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 minimum_pre_commit_version: 2.9.3
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: check-merge-conflict
         description: Check for files that contain merge conflict strings.
@@ -28,33 +28,33 @@ repos:
           Sort the lines in specified files (defaults to alphabetical).
           You must provide list of target files as input in your .pre-commit-config.yaml file.
         files: ^(.*requirements.*\.txt|\.brokignore)$
-  - repo: https://github.com/timothycrosley/isort
-    rev: "5.12.0"
+  - repo: https://github.com/PyCQA/isort
+    rev: "5.13.2"
     hooks:
       - id: isort
         description: isort is a Python utility / library to sort imports automatically.
         files: ^((noxfile|conf)|docs/.*)\.py$
   - repo: https://github.com/psf/black
-    rev: 23.9.1
+    rev: 24.10.0
     hooks:
       - id: black
         description: Forces best practice formatting of Python code files.
         files: ^((noxfile|conf)|docs/conf|tools/version-updater|docs/_includes/python/.*)\.py$
   - repo: https://github.com/myint/rstcheck
-    rev: v6.2.0
+    rev: v6.2.4
     hooks:
       - id: rstcheck
         description: Checks syntax of reStructuredText/rst and code blocks nested within it.
         args: [--report-level=warning]
         additional_dependencies: [sphinx]
         files: ^(index|docs/.*|docs/_includes/.*|README|CONTRIBUTING)\.rst$
   - repo: https://github.com/asottile/blacken-docs
-    rev: 1.16.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==23.9.1]
+        additional_dependencies: [black==24.10.0]
 
 #  - repo: https://github.com/saltstack/mirrors-nox
 #    rev: v2022.11.21

.rstcheck.cfg

@@ -47,4 +47,22 @@ ignore_substitutions=
   windows-x86-exe-md5,
   windows-x86-exe-sha256,
   windows-amd64-exe-gpg,
+  macos-amd64-lts-download,
+  macos-arm64-lts-download,
+  macos-amd64-sts-download,
+  macos-arm64-sts-download,
+  minor-lts-version-badge,
+  minor-sts-version-badge,
+  windows-amd64-exe-lts-download,
+  windows-amd64-msi-lts-download,
+  windows-x86-exe-lts-download,
+  windows-x86-msi-lts-download,
+  windows-amd64-exe-sts-download,
+  windows-amd64-msi-sts-download,
+  windows-x86-exe-sts-download,
+  windows-x86-msi-sts-download,
+  minor-lts-version,
+  minor-sts-version,
+  relenv-lts-python-version,
+  relenv-sts-python-version,
 ignore_messages=(.*(aix|arista)\.rst.* \(ERROR\/3\) Error in "code-block" directive\:$)

docs/topics/access-old-packages.rst

@@ -21,4 +21,4 @@ policy for older versions.
 
     Packages for unsupported versions of Salt, older than Salt 3006 LTS, are
     **NO LONGER AVAILABLE** in the Salt package repositories. See
-    `Salt Blog: Salt Project Package Repository (repo.saltproject.io) Migration and Guidance <https://saltproject.io/blog/salt-project-package-repo-migration-and-guidance/>`__
+    `FAQs from Salt Project Repo Migration and Open Hour <https://saltproject.io/blog/post-migration-salt-project-faqs/>`__

tools/version-updater.py

@@ -1,6 +1,7 @@
 """
 Script to download Salt versions manifest and prep docs where version specific info is required
 """
+
 from pathlib import Path
 import json
 import shutil