Merge branch 'main' into tilda_env

Author: adamperkowski

.cargo/config.toml

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

.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
 

.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]).

.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/release-drafter.yml

@@ -0,0 +1,35 @@
+changelog:
+  categories:
+    - title: '🚀 Features'
+      labels:
+        - 'enhancement'
+    - title: '🐛 Bug Fixes'
+      labels:
+        - 'bug'
+    - title: '⚙️ Refactoring'
+      labels:
+        - 'refactor'
+    - title: '🧩 UI/UX'
+      labels:
+        - 'UI/UX'
+    - title: '📚 Documentation'
+      labels:
+        - 'documentation'
+    - title: '🔒 Security'
+      labels:
+        - 'security'
+    - title: '🧰 GitHub Actions'
+      labels:
+        - 'github_actions'
+    - title: '🦀 Rust'
+      labels:
+        - 'rust'
+    - title: '📃 Scripting'
+      labels:
+        - 'script'
+    - title: 'Other Changes'
+      labels:
+        - "*"
+  exclude:
+    labels:
+      - 'skip-changelog'

.github/release.yml

@@ -3,7 +3,7 @@ name: Check for bashisms
 on:
   pull_request:
     paths:
-      - core/tabs/**
+      - 'core/tabs/**/*.sh'
   merge_group:
   workflow_dispatch:
 
@@ -15,21 +15,33 @@ jobs:
       - uses: actions/checkout@v4
       - run: git fetch origin ${{ github.base_ref }}
 
-      - name: Get a list of changed script files
-        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"
-      
       - name: Install devscripts
-        if: steps.get_sh_files.outputs.sh_files != ''
-        run: sudo apt-get update && sudo apt-get install devscripts
+        run: sudo apt-get update && sudo apt-get install -y devscripts
+
+      - name: Get changed .sh files (PR only)
+        id: changed-sh-files
+        if: github.event_name == 'pull_request'
+        uses: tj-actions/changed-files@v45
+        with:
+          files: '**/*.sh'
+
+      - name: Get all .sh files (if workflow dispatched)
+        id: sh-files
+        if: github.event_name != 'pull_request'
+        run: |
+          files=$(find . -type f -name "*.sh" | tr '\n' ' ')
+          echo "files=${files:-none}" >> $GITHUB_ENV
+
+      - name: Set FILES for bashism check
+        id: set-files
+        run: |
+          if [[ "${{ steps.changed-sh-files.outputs.any_changed }}" == 'true' ]]; then
+            echo "FILES=${{ steps.changed-sh-files.outputs.all_changed_files }}" >> $GITHUB_ENV
+          else
+            echo "FILES=${{ env.files }}" >> $GITHUB_ENV
+          fi
 
       - name: Check for bashisms
-        if: steps.get_sh_files.outputs.sh_files != ''
         run: |
-          for file in ${{ steps.get_sh_files.outputs.sh_files }}; do
-              if [[ -f "$file" ]]; then
-                  checkbashisms "$file"
-              fi
-          done
+          IFS=' ' read -r -a file_array <<< "$FILES"
+          checkbashisms "${file_array[@]}"

.github/workflows/bashisms.yml

@@ -13,13 +13,34 @@ on:
 jobs:
   build-and-deploy:
     runs-on: ubuntu-latest
+    environment: linutil_env
+    permissions:
+      contents: write
+      pull-requests: write
 
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
         with:
           fetch-depth: '0'  # Fetch all commit history for all branches as well as tags.
 
+      - name: Copy Contributing Guidelines
+        run: |
+          echo -e "<!-- THIS FILE IS GENERATED AUTOMATICALLY. EDIT .github/CONTRIBUTING.md -->\n\n$(cat .github/CONTRIBUTING.md)" > 'docs/contributing.md'
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v6
+        with:
+          commit-message: Update Contributing Guidelines
+          title: 'docs: Update Contributing Guidelines'
+          body: 'Automated update of Contributing Guidelines from .github/CONTRIBUTING.md'
+          branch: update-contributing-guidelines
+          delete-branch: true
+          base: main
+          labels: documentation
+          token: ${{ secrets.PAT_TOKEN }}
+        if: success()
+
       - name: Setup Python
         uses: actions/setup-python@v5
         with:

.github/workflows/github-pages.yml

@@ -1,8 +1,6 @@
 name: LinUtil Release
 
 on:
-  push:
-    branches: ["main"]
   workflow_dispatch:
 
 permissions:
@@ -48,25 +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
-
-      - name: Pull latest changes
         run: |
-          git config --global user.email "[email protected]"
-          git config --global user.name "GitHub Actions"
-          git pull origin main
-
-      - 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
@@ -75,31 +57,21 @@ jobs:
           echo "version=$version" >> $GITHUB_ENV
         shell: bash
 
-      - name: Generate Release Notes
-        id: generate_notes
-        uses: release-drafter/release-drafter@v6
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          config-name: release-drafter.yml
-          version: ${{ env.version }}
-
       - name: Create and Upload Release
         id: create_release
         uses: softprops/action-gh-release@v2
         with:
           tag_name: ${{ env.version }}
           name: Pre-Release ${{ env.version }}
           body: |
-            ${{ steps.generate_notes.outputs.body }}
-            
             ![GitHub Downloads (specific asset, specific tag)](https://img.shields.io/github/downloads/ChrisTitusTech/linutil/${{ env.version }}/linutil)
             ![GitHub Downloads (specific asset, specific tag)](https://img.shields.io/github/downloads/ChrisTitusTech/linutil/${{ env.version }}/linutil-aarch64)
 
-          append_body: false
+          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