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

ChrisTitusTech · Nov 1, 2024 · ee601dc · ee601dc
2 parents eb9c13c + 4f4becc
commit ee601dc
Show file tree

Hide file tree

Showing 54 changed files with 889 additions and 645 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -16,6 +16,7 @@ cd linutil
    ```
 
 ## 3. Make your changes
+
 - **Edit the files you want to change**: Make your changes to the relevant files.
 - **Test your changes**: Run `cargo run` to test your modifications in a local environment and ensure everything works as expected.
 
@@ -60,6 +61,7 @@ cd linutil
 ## 11. Documentation
 
 - **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this.
+- **Automatic generation**: If you decide to add functionality through a new shell script, make sure to fill out all fields in `tab_data.toml` and run `cargo xtask docgen`.
 
 ## 12. License
 

diff --git a/.github/SECURITY.md b/.github/SECURITY.md
@@ -2,13 +2,20 @@
 
 ## Supported Versions
 
-It is recommended that you run the stable version as this is more tested and used by most. The dev branch is bleed-edge commits that are not well tested and aren't meant to be used in production environments
+It is recommended that you use the stable branch as it's tested and used by most. The dev branch may contain bleeding-edge commits that are not well tested and are not meant to be used in production environments.<br>
+Version tags lower than the [latest stable release](https://github.com/ChrisTitusTech/linutil/releases/latest) are **not** supported.
 
-| Version | Supported          |
-| ------- | ------------------ |
-| latest  | :white_check_mark: |
-| dev     | :x:                |
+| Branch  | Supported              |
+| ------- | ---------------------- |
+| Stable  | :white_check_mark: YES |
+| Dev     | :x:                 NO |
+
+| Version                                            | Supported              |
+| -------------------------------------------------- | ---------------------- |
+| [![LATEST](https://img.shields.io/github/v/release/ChrisTitusTech/linutil?color=%230567ff&label=Latest&style=for-the-badge)](https://github.com/ChrisTitusTech/linutil/releases/latest) | :white_check_mark: YES |
+| Below LATEST                                       | :x:                 NO |
+| Above LATEST                                       | :x:                 NO |
 
 ## Reporting a Vulnerability
 
-I'd recommend making an Issue for reporting a bug. If you would like privately submit the bug you can email me at [email protected]
+If you have any reason to believe there are security vulnerabilities in Linutil, fill out the [report form](https://github.com/christitustech/linutil/security/advisories/new) or e-mail [[email protected]](mailto:[email protected]).
diff --git a/.github/release.yml b/.github/release.yml
@@ -2,19 +2,34 @@ changelog:
   categories:
     - title: '🚀 Features'
       labels:
-        - 'feature'
         - 'enhancement'
     - title: '🐛 Bug Fixes'
       labels:
-        - 'fix'
-        - 'bugfix'
         - 'bug'
+    - title: '⚙️ Refactoring'
+      labels:
+        - 'refactor'
+    - title: '🧩 UI/UX'
+      labels:
+        - 'UI/UX'
     - title: '📚 Documentation'
-      label: 'documentation'
+      labels:
+        - 'documentation'
     - title: '🔒 Security'
-      label: 'security'
+      labels:
+        - 'security'
     - title: '🧰 GitHub Actions'
-      label: 'github actions'
+      labels:
+        - 'github_actions'
+    - title: '🦀 Rust'
+      labels:
+        - 'rust'
+    - title: '📃 Scripting'
+      labels:
+        - 'script'
+    - title: 'Other Changes'
+      labels:
+        - "*"
   exclude:
     labels:
-      - 'skip-changelog'
+      - 'skip-changelog'
diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml
@@ -22,7 +22,7 @@ jobs:
 
       - name: Copy Contributing Guidelines
         run: |
-          echo "<!-- THIS FILE IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->\n\n$(cat .github/CONTRIBUTING.md)" > 'docs/contributing.md'
+          echo -e "<!-- 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:

diff --git a/.github/workflows/linutil.yml b/.github/workflows/linutil.yml
@@ -46,19 +46,9 @@ jobs:
         run: cargo build --target-dir=build --release --verbose --target=x86_64-unknown-linux-musl --all-features
 
       - name: Build aarch64 binary
-        run: cross build --target-dir=build --release --verbose --target=aarch64-unknown-linux-musl --all-features
-
-      - name: Move binaries to build directory
         run: |
-          mv build/x86_64-unknown-linux-musl/release/linutil build/linutil
-          mv build/aarch64-unknown-linux-musl/release/linutil build/linutil-aarch64
-
-      - uses: stefanzweifel/git-auto-commit-action@v5
-        with:
-          commit_message: Commit Linutil
-          file_pattern: "build/linutil build/linutil-aarch64"
-          add_options: '--force'
-        if: success()
+          cross build --target-dir=build --release --verbose --target=aarch64-unknown-linux-musl --all-features
+          mv ./build/aarch64-unknown-linux-musl/release/linutil ./build/aarch64-unknown-linux-musl/release/linutil-aarch64
 
       - name: Extract Version
         id: extract_version
@@ -80,32 +70,19 @@ jobs:
           append_body: true
           generate_release_notes: true
           files: |
-            ./build/linutil
-            ./build/linutil-aarch64
+            ./build/x86_64-unknown-linux-musl/release/linutil
+            ./build/aarch64-unknown-linux-musl/release/linutil-aarch64
             ./start.sh
             ./startdev.sh
           prerelease: true
         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
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
         with:
-          commit_message: Preview for ${{ env.version }}
-          file_pattern: "docs/assets/preview.gif"
-          add_options: "--force"
-        if: success()
+          name: linutil-artifact
+          path: build/x86_64-unknown-linux-musl/release/linutil
+          compression-level: 0
+          overwrite: true
diff --git a/.github/workflows/preview.yml b/.github/workflows/preview.yml
@@ -0,0 +1,55 @@
+name: LinUtil Preview
+
+on:
+  workflow_dispatch:
+    inputs:
+        run_id:
+          description: 'Run ID of LinUtil Release'
+          required: true
+  workflow_run:
+    workflows: ["LinUtil Release"]
+    types:
+      - completed
+
+jobs:
+  generate_preview:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set Run ID
+        run: |
+          if [ "${{ github.event_name }}" == "workflow_run" ]; then
+            echo "run_id=${{ github.event.workflow_run.id }}" >> $GITHUB_ENV
+          else
+            echo "run_id=${{ github.event.inputs.run_id }}" >> $GITHUB_ENV
+          fi
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: linutil-artifact
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          run-id: ${{ env.run_id }}
+
+      - name: Set env
+        run: |
+          chmod +x linutil
+          echo "${{ github.workspace }}" >> $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.run_id }}
+          file_pattern: "docs/assets/preview.gif"
+          add_options: "--force"
+        if: success()
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -5,7 +5,7 @@ on:
     branches: ["main"]
     paths:
       - '**/*.rs'
-      - 'Cargo.toml'
+      - '**/Cargo.toml'
       - 'Cargo.lock'
 
 env:

diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml
@@ -1,55 +1,34 @@
-name: ShellCheck
+name: Script Checks
 
 on:
   pull_request:
     paths:
-      - 'core/tabs/**/*.sh'
+      - '**/*.sh'
   workflow_dispatch:
 
 jobs:
   shellcheck:
     name: Shellcheck
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - run: git fetch origin ${{ github.base_ref }}
+      - name: Checkout sources
+        uses: actions/checkout@v4
 
-      - name: Download, setup, and run ShellCheck
-        shell: bash {0}
-        run : |
-          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"
+      - name: Run ShellCheck
+        uses: reviewdog/action-shellcheck@v1
+        with:
+          reviewdog_flags: '-fail-level=any'
 
-          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
-                  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
+  shfmt:
+    name: Shell Fomatting
+    runs-on: ubuntu-latest
+    needs: shellcheck
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+
+      - name: Run shfmt
+        uses: reviewdog/action-shfmt@v1
+        with:
+          shfmt_flags: '-i 4 -ci'
+          reviewdog_flags: '-fail-level=any'
diff --git a/.github/workflows/typos.yml b/.github/workflows/typos.yml
@@ -12,4 +12,4 @@ jobs:
       - run: git fetch origin ${{ github.base_ref }}
 
       - name: Run spellcheck
-        uses: crate-ci/typos@v1.25.0
+        uses: crate-ci/typos@v1.26.0