chore(workflow): clean up rust.yml for clarity and consistency

- Removed commented-out sections and unnecessary comments for a more streamlined workflow file.
- Ensured consistent formatting and clarity in job definitions and steps.

Author: kWAYTV

.github/workflows/rust.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches: ["master"]
 
-# Grant permissions for release-please to create PRs, write releases, and commit files
 permissions:
   contents: write
   pull-requests: write
@@ -15,48 +14,25 @@ concurrency:
 
 env:
   CARGO_TERM_COLOR: always
-  # IMPORTANT: Set this to the name of your crate as defined in Cargo.toml
-  # This is used by release-please and for naming artifacts.
   CRATE_NAME: rust-commit-tracker
 
 jobs:
-  # This job handles versioning, changelog generation, and creating Release PRs.
-  # When a Release PR is merged, it creates the Git tag and GitHub Release.
   release-please:
     runs-on: ubuntu-latest
     outputs:
       release_created: ${{ steps.release.outputs.release_created }}
       tag_name: ${{ steps.release.outputs.tag_name }}
-      # 'version' output by release-please is the raw version, e.g., "1.2.3"
-      # 'tag_name' is typically "v1.2.3"
       version: ${{ steps.release.outputs.version }}
-      upload_url: ${{ steps.release.outputs.upload_url }} # URL for uploading release assets
+      upload_url: ${{ steps.release.outputs.upload_url }}
     steps:
       - uses: googleapis/release-please-action@v4
         id: release
         with:
           release-type: rust
           token: ${{ secrets.GITHUB_TOKEN }}
-          # Explicitly provide the package name if Cargo.toml is not at the root,
-          # or if you want to be very specific.
-
-          # Optional: If you want minor bumps for 'feat' before v1.0.0
-          # bump-minor-pre-major: true
-          # Optional: If you want patch bumps for 'fix' before v1.0.0
-          # bump-patch-for-minor-pre-major: true
-          # Optional: Customize the path to your changelog
-          # changelog-path: CHANGELOG.md
-
-  # Your existing test job - good to keep!
-  # release-please will create PRs based on commits to master.
-  # Ensure your master branch is protected and requires tests to pass.
+
   test:
     runs-on: ubuntu-latest
-    # You might want this to run on PRs to master as well,
-    # especially for the Release PRs created by release-please.
-    # on:
-    #   pull_request:
-    #     branches: ["master"]
     steps:
       - uses: actions/checkout@v4
       - name: Install Rust toolchain
@@ -66,35 +42,32 @@ jobs:
       - name: Run tests
         run: cargo test --verbose
 
-  # This job builds the binaries for different targets.
-  # It only runs IF a release was actually created by release-please (i.e., Release PR merged).
   build-binaries:
-    needs: [release-please, test] # Ensure tests pass and release is initiated
+    needs: [release-please, test]
     if: needs.release-please.outputs.release_created == 'true'
-    runs-on: ${{ matrix.os }} # Use the OS specified in the matrix
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         include:
           - target: x86_64-pc-windows-gnu
-            os: ubuntu-latest # Cross-compile Windows on Linux
+            os: ubuntu-latest
             asset_name_suffix: .exe
             archive_format: zip
           - target: x86_64-unknown-linux-gnu
             os: ubuntu-latest
             asset_name_suffix: ""
             archive_format: tar.gz
           - target: x86_64-apple-darwin
-            os: macos-latest # Build macOS on macOS
+            os: macos-latest
             asset_name_suffix: ""
             archive_format: tar.gz
     steps:
       - uses: actions/checkout@v4
-        # No need for fetch-depth: 0 here, building from the release commit.
 
       - name: Install Rust toolchain for target
         uses: dtolnay/rust-toolchain@stable
         with:
-          toolchain: stable # Or a specific version
+          toolchain: stable
           targets: ${{ matrix.target }}
 
       - name: Install cross-compilation tools (for Windows target on Linux)
@@ -113,11 +86,9 @@ jobs:
 
       - name: Determine Asset Names
         id: asset_names
-        shell: bash # Ensure bash is used for consistency
+        shell: bash
         run: |
-          # Use the CRATE_NAME from env for the binary's base name
           local_crate_name="${{ env.CRATE_NAME }}"
-          # Use the tag_name from release-please for versioning in the archive
           local_tag_name="${{ needs.release-please.outputs.tag_name }}"
 
           binary_filename="${local_crate_name}${{ matrix.asset_name_suffix }}"
@@ -129,7 +100,7 @@ jobs:
           echo "packaged_binary_name=${binary_filename}" >> $GITHUB_OUTPUT
 
       - name: Package binary
-        shell: bash # Ensure bash is used
+        shell: bash
         run: |
           mkdir -p dist
           cp "${{ steps.asset_names.outputs.binary_path }}" "dist/${{ steps.asset_names.outputs.packaged_binary_name }}"
@@ -139,7 +110,7 @@ jobs:
           else
             tar -czf "${{ steps.asset_names.outputs.asset_upload_name }}" "${{ steps.asset_names.outputs.packaged_binary_name }}"
           fi
-          cd .. # Go back to the original directory
+          cd ..
 
       - name: Upload Release Asset
         uses: actions/upload-release-asset@v1
@@ -149,22 +120,19 @@ jobs:
           upload_url: ${{ needs.release-please.outputs.upload_url }}
           asset_path: ${{ steps.asset_names.outputs.archive_path }}
           asset_name: ${{ steps.asset_names.outputs.asset_upload_name }}
-          asset_content_type: application/octet-stream # Or specific types like application/zip
+          asset_content_type: application/octet-stream
 
-  # Optional: Job to publish your crate to crates.io
   publish-crate:
-    needs: [release-please, test] # Depends on a release being created and tests passing
+    needs: [release-please, test]
     if: needs.release-please.outputs.release_created == 'true'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
         with:
-          # Checkout the specific commit that was tagged for this release
           ref: ${{ needs.release-please.outputs.tag_name }}
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable
 
       - name: Publish to crates.io
         run: cargo publish --token ${{ secrets.CARGO_REGISTRY_TOKEN }}
-        # Ensure CARGO_REGISTRY_TOKEN is set as a secret in your GitHub repository settings