Merge remote-tracking branch 'upstream/main' into savestate

.cargo/config.toml

@@ -0,0 +1,2 @@
+[alias]
+xtask = "run --package xtask --"

.github/mkdocs.yml

@@ -6,7 +6,7 @@ nav:
   - Introduction: 'index.md'
   - User Guide: 'userguide.md'
   - Contributing:
-      - Contributing Guide: 'contribute.md'
+      - Contributing Guide: 'contributing.md'
       - Roadmap: 'roadmap.md'
   - Documentation:
       - Known Issues: 'KnownIssues.md'
@@ -86,4 +86,4 @@ plugins:
       minify_html: true
       htmlmin_opts:
           remove_comments: true
-      cache_safe: true
+      cache_safe: true

.github/workflows/bashisms.yml

@@ -19,17 +19,27 @@ jobs:
         id: get_sh_files
         run: |
           sh_files=$(git diff --name-only origin/${{ github.base_ref }} HEAD core/tabs | grep '\.sh$' || true)
-          echo "::set-output name=sh_files::$sh_files"
+          if [ -n "$sh_files" ]; then
+            echo "$sh_files" > changed_files
+            echo "changed=1" >> $GITHUB_OUTPUT
+          else
+            echo "changed=0" >> $GITHUB_OUTPUT
+          fi
       
       - name: Install devscripts
-        if: steps.get_sh_files.outputs.sh_files != ''
+        if: steps.get_sh_files.outputs.changed == 1
         run: sudo apt-get update && sudo apt-get install devscripts
 
       - name: Check for bashisms
-        if: steps.get_sh_files.outputs.sh_files != ''
+        if: steps.get_sh_files.outputs.changed == 1
         run: |
-          for file in ${{ steps.get_sh_files.outputs.sh_files }}; do
-              if [[ -f "$file" ]]; then
-                  checkbashisms "$file"
-              fi
+          echo "Running for:\n$(cat changed_files)\n"
+          for file in $(cat changed_files); do
+            if [[ -f "$file" ]]; then
+              checkbashisms "$file"
+            fi
           done
+
+      - name: Remove the created file
+        if: steps.get_sh_files.outputs.changed == 1
+        run: rm changed_files

.github/workflows/github-pages.yml

@@ -20,6 +20,17 @@ jobs:
         with:
           fetch-depth: '0'  # Fetch all commit history for all branches as well as tags.
 
+      - name: Copy Contributing Guidelines
+        run: |
+          echo "<!-- THIS FILE IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->\n\n$(cat .github/CONTRIBUTING.md)" > 'docs/contributing.md'
+
+      - uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: Commit Contributing Guidelines
+          file_pattern: "docs/contributing.md"
+          add_options: '--force'
+        if: success()
+
       - name: Setup Python
         uses: actions/setup-python@v5
         with:

.github/workflows/linutil.yml

@@ -88,3 +88,24 @@ jobs:
         env:
           version: ${{ env.version }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Setup Preview
+        run: |
+          echo "$(pwd)/build" >> $GITHUB_PATH
+      
+      - name: Generate preview 
+        uses: charmbracelet/[email protected]
+        with:
+          path: "docs/assets/preview.tape"
+
+      - name: Move preview
+        run: |
+          mv preview.gif docs/assets/preview.gif
+
+      - name: Upload preview
+        uses: stefanzweifel/git-auto-commit-action@v5
+        with:
+          commit_message: Preview for ${{ env.version }}
+          file_pattern: "docs/assets/preview.gif"
+          add_options: "--force"
+        if: success()

.github/workflows/shellcheck.yml

@@ -14,17 +14,42 @@ jobs:
       - uses: actions/checkout@v4
       - run: git fetch origin ${{ github.base_ref }}
 
-      - name: Download and set up shellcheck
+      - name: Download, setup, and run ShellCheck
+        shell: bash {0}
         run : |
-          wget https://github.com/koalaman/shellcheck/releases/download/v0.10.0/shellcheck-v0.10.0.linux.x86_64.tar.xz
-          tar -xf shellcheck-v0.10.0.linux.x86_64.tar.xz
-          cd shellcheck-v0.10.0
-          chmod +x shellcheck
-
-      - name: Run shellcheck
-        run: |
-          for file in $(git diff --name-only origin/${{ github.base_ref }} HEAD core/tabs); do
+          SC_URL="https://github.com/koalaman/shellcheck/releases/download/v0.10.0/shellcheck-v0.10.0.linux.x86_64.tar.xz"
+          curl -fsSL "$SC_URL" | tar -Jx
+          chmod +x "./shellcheck-v0.10.0/shellcheck"
+
+          error=0
+          files_to_check=$(git diff --name-only origin/${{ github.base_ref }} HEAD core/tabs)
+
+          for file in $files_to_check; do
               if [[ "$file" == *.sh ]] && [[ -f "$file" ]]; then
-                  ./shellcheck-v0.10.0/shellcheck -S error "$file"
+                  sc_output=$(./shellcheck-v0.10.0/shellcheck -fgcc -Serror "$file")
+                  iter_safe_parsed_errors=$(echo -e "$sc_output" | sed -n 's/\(.\+\)\:\([0-9]\+\)\:\([0-9]\+\)\: \(.*\)/::error file=\1,line=\2,col=\3::\4/p' | sed 's/ /:space:/g')
+
+                  for error in $iter_safe_parsed_errors; do
+                      echo "$error" | sed 's/:space:/ /g'
+                      error=1
+                  done
+
+                  tabs_detected=$(grep -nP '^\t+\S+' "$file")
+
+                  # fast fail on the action runner would fail immediately if there weren't any tabs found
+                  # this check makes sure that we don't continue if there's something really weird going on
+                  if [ "$?" = "2" ]; then
+                      echo "::error file=$file::There was a critical error while grepping $file, aborting"
+                      exit 1
+                  fi
+
+                  iter_safe_parsed_tabs_detected=$(echo "$tabs_detected" | sed -n 's,\([0-9]\+\).*,::error file='"$file"'\,line=\1::Found tab indentations,p' | sed 's/ /:space:/g')
+
+                  for error in $iter_safe_parsed_tabs_detected; do
+                      echo "$error" | sed 's/:space:/ /g'
+                      error=1
+                  done
               fi
           done
+
+          exit $error

.github/workflows/typos.yml

@@ -0,0 +1,15 @@
+name: Check for typos
+
+on:
+  [push, pull_request, workflow_dispatch]
+
+jobs:
+  check-typos:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - run: git fetch origin ${{ github.base_ref }}
+
+      - name: Run spellcheck
+        uses: crate-ci/[email protected]

.github/workflows/xtask.yml

@@ -0,0 +1,58 @@
+name: XTasks
+
+on:
+  pull_request:
+    paths:
+      - "xtask"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".cargo"
+      - "core/tabs"
+      - "docs"
+  push:
+    paths:
+      - "xtask"
+      - "Cargo.toml"
+      - "Cargo.lock"
+      - ".cargo"
+      - "core/tabs"
+      - "docs"
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  docgen:
+    name: DocGen
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@stable
+
+      - name: Cache Cargo registry
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/registry
+          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ runner.os }}-cargo-registry-
+
+      - name: Cache Cargo index
+        uses: actions/cache@v4
+        with:
+          path: ~/.cargo/git
+          key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }}
+          restore-keys: ${{ runner.os }}-cargo-index-
+
+      - name: Run cargo xtask docgen
+        run: cargo xtask docgen
+
+      - name: Check uncommitted documentation changes
+        run: |
+          git diff
+          git diff-files --quiet \
+            || (echo "Run 'cargo xtask docgen' and push the changes" \
+            && exit 1)