ci: clean up CI, update python action + version (#1636)

* ci: clean up CI

* bump python action, also version to 3.12

.github/workflows/ci.yml

@@ -1,5 +1,5 @@
-# Main CI workflow to validate PRs and branches are correctly formatted
+# Main CI workflow to validate that files are formatted correctly, pass tests,
-# and pass tests.
+# and pass lints.
 #
 # CI workflow was based on a lot of work from other people:
 # - https://github.com/heim-rs/heim/blob/master/.github/workflows/ci.yml
@@ -8,16 +8,12 @@
 # - https://matklad.github.io/2021/09/04/fast-rust-builds.html
 #
 # Supported platforms run the following tasks:
-# - cargo fmt
+# - Format
-# - cargo test (built/test in separate steps)
+# - Test (built/test in separate steps)
-# - cargo clippy (apparently faster to do it after the build/test)
+# - Clippy (apparently faster to do it after the build/test)
 #
 # Unsupported platforms run the following tasks:
-# - cargo build
+# - Clippy
-#
-# Note that not all platforms are tested using this CI action! There are some
-# tested by Cirrus CI due to (free) platform limitations on GitHub. Currently,
-# this is just macOS M1 and FreeBSD.
 
 name: ci
 
@@ -250,7 +246,7 @@ jobs:
           key: ${{ matrix.info.target }}
           cache-all-crates: true
 
-      - name: Check (default features)
+      - name: Clippy (default features)
         uses: ClementTsang/cargo-action@v0.0.5
         if: ${{ matrix.info.no-default-features != true }}
         with:
@@ -259,7 +255,7 @@ jobs:
           use-cross: ${{ matrix.info.cross }}
           cross-version: ${{ matrix.info.cross-version || '0.2.5' }}
 
-      - name: Check (no features enabled)
+      - name: Clippy (no features enabled)
         uses: ClementTsang/cargo-action@v0.0.5
         if: ${{ matrix.info.no-default-features == true  }}
         with:
@@ -312,7 +308,7 @@ jobs:
           key: ${{ matrix.info.target }}-${{ matrix.info.os_release }}
           cache-all-crates: true
 
-      - name: Test FreeBSD
+      - name: Clippy (FreeBSD)
         if: ${{ matrix.info.type == 'freebsd' }}
         uses: vmactions/freebsd-vm@v1.0.8
         with:

.github/workflows/docs.yml

@@ -1,6 +1,7 @@
 # Workflow to deploy mkdocs documentation.
 
 name: docs
+
 on:
   workflow_dispatch:
   push:
@@ -25,9 +26,9 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0
+      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
         with:
-          python-version: 3.11
+          python-version: 3.12
 
       - name: Install Python dependencies
         run: pip install -r docs/requirements.txt

.github/workflows/post_release.yml

@@ -27,22 +27,18 @@ jobs:
       version: ${{ env.VERSION }}
     steps:
       - name: Get the release version from the tag
-        if: env.VERSION == ''
         run: |
           if [[ -n "${{ github.event.inputs.tag }}" ]]; then
             echo "Manual run against a tag; overriding actual tag in the environment..."
-            echo "VERSION=${{ github.event.inputs.tag }}" >> $GITHUB_ENV
+            echo "VERSION=${{ github.event.inputs.tag }}" >> "$GITHUB_ENV"
           else
-            echo "VERSION=${{ github.event.release.tag_name }}" >> $GITHUB_ENV
+            echo "VERSION=${{ github.event.release.tag_name }}" >> "$GITHUB_ENV"
           fi
 
-      - name: Test env
-        run: |
-          echo ${{ env.VERSION }}
-
       - name: Make sure you're not on master/main/nightly
         run: |
-          if [[ ${{ env.VERSION }} == "master" || ${{ env.VERSION }} == "main" || ${{ env.VERSION }} == "nightly" ]]; then
+          echo ${{ env.VERSION }} 
+          if [[ ${{ env.VERSION }} == "master" || ${{ env.VERSION }}  == "main" || ${{ env.VERSION }}  == "nightly" ]]; then
             exit 1
           fi
 
@@ -64,9 +60,9 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0
+      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
         with:
-          python-version: 3.11
+          python-version: 3.12
 
       - name: Install Python dependencies
         run: pip install -r docs/requirements.txt

.github/workflows/test_docs.yml

@@ -1,6 +1,7 @@
 # Small CI workflow to test if mkdocs documentation can be successfully built.
 
 name: test docs
+
 on:
   workflow_dispatch:
   pull_request:
@@ -33,9 +34,9 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0
+      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
         with:
-          python-version: 3.11
+          python-version: 3.12
 
       - name: Install Python dependencies
         run: pip install -r docs/requirements.txt

.github/workflows/validate_schema.yml

@@ -39,9 +39,9 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@0a5c61591373683505ea898e09a3ea4f39ef2b9c # v5.0.0
+      - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
         with:
-          python-version: 3.11
+          python-version: 3.12
 
       - name: Install Python dependencies
         run: pip install -r scripts/schema/requirements.txt