Refactor GitHub Actions workflows to use a common build process and update domain in docs deployment

jensenbox · jensenbox · commit 165ba0459112 · 2025-06-08T15:56:36.000-07:00
diff --git a/.github/workflows/common-build.yml b/.github/workflows/common-build.yml
@@ -0,0 +1,60 @@
+name: Common Build Steps
+
+on:
+  workflow_call:
+    inputs:
+      rust_target:
+        description: 'Rust target triple'
+        required: false
+        type: string
+        default: ''
+      run_tests:
+        description: 'Whether to run tests'
+        required: false
+        type: boolean
+        default: true
+    outputs:
+      version:
+        description: "Version extracted from the release tag"
+        value: ${{ jobs.build.outputs.version }}
+
+jobs:
+  build:
+    name: Build
+    runs-on: ${{ inputs.os || 'ubuntu-latest' }}
+    outputs:
+      version: ${{ steps.version.outputs.version }}
+    
+    steps:
+    - uses: actions/checkout@v3
+    
+    - name: Install Rust
+      uses: actions-rs/toolchain@v1
+      with:
+        profile: minimal
+        toolchain: stable
+        override: true
+        target: ${{ inputs.rust_target }}
+    
+    - name: Build
+      run: |
+        if [ -n "${{ inputs.rust_target }}" ]; then
+          cargo build --release --target ${{ inputs.rust_target }}
+        else
+          cargo build --release
+        fi
+    
+    - name: Run tests
+      if: inputs.run_tests
+      run: |
+        if [ -n "${{ inputs.rust_target }}" ]; then
+          cargo test --release --target ${{ inputs.rust_target }}
+        else
+          cargo test --release
+        fi
+    
+    - name: Extract version
+      id: version
+      run: |
+        VERSION=${GITHUB_REF#refs/tags/v}
+        echo "version=$VERSION" >> $GITHUB_OUTPUT
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -35,4 +35,4 @@ jobs:
           publish_dir: ./docs/book/book
           publish_branch: gh-pages
           force_orphan: true
-          cname: rustyhook.com  # Optional: Set a custom domain
+          cname: rustyhook.dev
diff --git a/.github/workflows/publish-brew.yml b/.github/workflows/publish-brew.yml
@@ -5,62 +5,58 @@ on:
     types: [created]
 
 jobs:
-  build-and-publish:
-    name: Build and publish to Homebrew
+  build:
+    uses: ./.github/workflows/common-build.yml
+    with:
+      rust_target: x86_64-apple-darwin
+      run_tests: false
+
+  publish:
+    name: Publish to Homebrew
     runs-on: macos-latest
-    
+    needs: build
+
     steps:
     - uses: actions/checkout@v3
-    
-    - name: Install Rust
-      uses: actions-rs/toolchain@v1
-      with:
-        profile: minimal
-        toolchain: stable
-        override: true
-        target: x86_64-apple-darwin
-    
-    - name: Build
-      run: cargo build --release --target x86_64-apple-darwin
-    
+
     - name: Install Homebrew
       run: |
         brew update
-    
+
     - name: Calculate SHA256
       id: sha
       run: |
-        VERSION=${GITHUB_REF#refs/tags/v}
+        VERSION="${{ needs.build.outputs.version }}"
         echo "version=$VERSION" >> $GITHUB_OUTPUT
-        
+
         # Create a tarball of the binary
         mkdir -p target/packages
         tar -czf target/packages/rustyhook-$VERSION-x86_64-apple-darwin.tar.gz -C target/x86_64-apple-darwin/release rh
-        
+
         # Calculate SHA256
         CHECKSUM=$(shasum -a 256 target/packages/rustyhook-$VERSION-x86_64-apple-darwin.tar.gz | awk '{print $1}')
         echo "sha256=$CHECKSUM" >> $GITHUB_OUTPUT
-    
+
     - name: Prepare Homebrew formula
       run: |
         VERSION=${{ steps.sha.outputs.version }}
         SHA256=${{ steps.sha.outputs.sha256 }}
-        
+
         # Create formula directory
         mkdir -p homebrew-rustyhook
-        
+
         # Copy and update formula
         cp packaging/homebrew/rustyhook.rb homebrew-rustyhook/rustyhook.rb
-        
+
         # Update version and SHA256
         sed -i '' "s/version \".*\"/version \"$VERSION\"/" homebrew-rustyhook/rustyhook.rb
         sed -i '' "s/sha256 \".*\"/sha256 \"$SHA256\"/" homebrew-rustyhook/rustyhook.rb
-    
+
     - name: Setup Git
       run: |
         git config --global user.name "GitHub Actions"
         git config --global user.email "actions@github.com"
-    
+
     - name: Create or update Homebrew tap repository
       run: |
         # Clone the tap repository if it exists, or create a new one
@@ -72,17 +68,17 @@ jobs:
           git init
           git remote add origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository_owner }}/homebrew-rustyhook.git
         fi
-        
+
         # Copy the formula
         cp ../homebrew-rustyhook/rustyhook.rb ./Formula/rustyhook.rb
-        
+
         # Commit and push
         git add Formula/rustyhook.rb
         git commit -m "Update rustyhook to ${{ steps.sha.outputs.version }}"
         git push -u origin main
-    
+
     - name: Upload artifacts
       uses: actions/upload-artifact@v3
       with:
         name: homebrew-formula
-        path: homebrew-rustyhook/
+        path: homebrew-rustyhook/
diff --git a/.github/workflows/publish-cargo.yml b/.github/workflows/publish-cargo.yml
@@ -5,48 +5,35 @@ on:
     types: [created]
 
 jobs:
-  build-and-publish:
-    name: Build and publish to crates.io
+  build:
+    uses: ./.github/workflows/common-build.yml
+    with:
+      run_tests: true
+
+  publish:
+    name: Publish to crates.io
     runs-on: ubuntu-latest
-    
+    needs: build
+
     steps:
     - uses: actions/checkout@v3
-    
-    - name: Install Rust
-      uses: actions-rs/toolchain@v1
-      with:
-        profile: minimal
-        toolchain: stable
-        override: true
-    
-    - name: Build
-      run: cargo build --release
-    
-    - name: Run tests
-      run: cargo test --release
-    
-    - name: Extract version
-      id: version
-      run: |
-        VERSION=${GITHUB_REF#refs/tags/v}
-        echo "version=$VERSION" >> $GITHUB_OUTPUT
-    
+
     - name: Verify Cargo.toml version
       run: |
         CARGO_VERSION=$(grep '^version' Cargo.toml | sed 's/.*"\(.*\)".*/\1/')
-        if [ "$CARGO_VERSION" != "${{ steps.version.outputs.version }}" ]; then
-          echo "Error: Version in Cargo.toml ($CARGO_VERSION) does not match release tag (${{ steps.version.outputs.version }})"
+        if [ "$CARGO_VERSION" != "${{ needs.build.outputs.version }}" ]; then
+          echo "Error: Version in Cargo.toml ($CARGO_VERSION) does not match release tag (${{ needs.build.outputs.version }})"
           exit 1
         fi
-    
+
     - name: Login to crates.io
       uses: actions-rs/cargo@v1
       with:
         command: login
         args: ${{ secrets.CRATES_IO_TOKEN }}
-    
+
     - name: Publish to crates.io
       uses: actions-rs/cargo@v1
       with:
         command: publish
-        args: --no-verify
+        args: --no-verify
diff --git a/.github/workflows/publish-winget.yml b/.github/workflows/publish-winget.yml
@@ -5,54 +5,50 @@ on:
     types: [created]
 
 jobs:
-  build-and-publish:
-    name: Build and publish to WinGet
+  build:
+    uses: ./.github/workflows/common-build.yml
+    with:
+      rust_target: x86_64-pc-windows-msvc
+      run_tests: false
+
+  publish:
+    name: Publish to WinGet
     runs-on: windows-latest
-    
+    needs: build
+
     steps:
     - uses: actions/checkout@v3
-    
-    - name: Install Rust
-      uses: actions-rs/toolchain@v1
-      with:
-        profile: minimal
-        toolchain: stable
-        override: true
-        target: x86_64-pc-windows-msvc
-    
-    - name: Build
-      run: cargo build --release --target x86_64-pc-windows-msvc
-    
+
     - name: Calculate hash and prepare package
       id: package
       shell: pwsh
       run: |
-        $VERSION = $env:GITHUB_REF -replace 'refs/tags/v', ''
+        $VERSION = "${{ needs.build.outputs.version }}"
         echo "version=$VERSION" >> $env:GITHUB_OUTPUT
-        
+
         # Create a zip of the binary
         New-Item -ItemType Directory -Path target/packages -Force
         Compress-Archive -Path target/x86_64-pc-windows-msvc/release/rh.exe -DestinationPath target/packages/rustyhook-v$VERSION-x86_64-pc-windows-msvc.zip
-        
+
         # Calculate SHA256
         $HASH = (Get-FileHash -Path target/packages/rustyhook-v$VERSION-x86_64-pc-windows-msvc.zip -Algorithm SHA256).Hash.ToLower()
         echo "sha256=$HASH" >> $env:GITHUB_OUTPUT
-    
+
     - name: Prepare WinGet manifest
       id: manifest
       shell: pwsh
       run: |
         $VERSION = "${{ steps.package.outputs.version }}"
         $HASH = "${{ steps.package.outputs.sha256 }}"
         $REPO_OWNER = "${{ github.repository_owner }}"
-        
+
         # Create winget directory
         New-Item -ItemType Directory -Path winget-manifest -Force
         New-Item -ItemType Directory -Path winget-manifest/RustyHook.RustyHook/$VERSION -Force
-        
+
         # Copy and update manifest
         Copy-Item -Path packaging/winget/rustyhook.yaml -Destination winget-manifest/RustyHook.RustyHook/$VERSION/RustyHook.RustyHook.yaml
-        
+
         # Update version, URL, and hash in the manifest
         $manifestPath = "winget-manifest/RustyHook.RustyHook/$VERSION/RustyHook.RustyHook.yaml"
         $manifestContent = Get-Content -Path $manifestPath -Raw
@@ -62,15 +58,15 @@ jobs:
         $manifestContent = $manifestContent -replace 'InstallerUrl: .*', "InstallerUrl: https://github.com/$REPO_OWNER/rustyhook/releases/download/v$VERSION/rustyhook-v$VERSION-x86_64-pc-windows-msvc.zip"
         $manifestContent = $manifestContent -replace 'InstallerSha256: .*', "InstallerSha256: $HASH"
         Set-Content -Path $manifestPath -Value $manifestContent
-        
+
         echo "manifest_path=winget-manifest" >> $env:GITHUB_OUTPUT
-    
+
     - name: Upload artifacts
       uses: actions/upload-artifact@v3
       with:
         name: winget-manifest
         path: ${{ steps.manifest.outputs.manifest_path }}
-    
+
     - name: Create PR to WinGet repository
       uses: peter-evans/create-pull-request@v5
       with:
@@ -85,12 +81,11 @@ jobs:
         title: "Add RustyHook version ${{ steps.package.outputs.version }}"
         body: |
           This PR adds the RustyHook package version ${{ steps.package.outputs.version }} to the WinGet repository.
-          
+
           - Package: RustyHook
           - Version: ${{ steps.package.outputs.version }}
           - Publisher: RustyHook Team
-          
+
           This is an automated PR created by the GitHub Actions workflow.
         draft: false
         base: master
-        repository: microsoft/winget-pkgs
diff --git a/docs/plan.md b/docs/plan.md
@@ -5,6 +5,7 @@ Tasks:
 - [x] create documentation for the project that can be pushed to github pages using a github action
 - [x] create a github action to publish the documentation to github pages
 - [x] Update the README to include a section on how to convert from pre-commit to rustyhook
+- [x] Remove the duplicate code in the github actions by consolidating the build steps and deployment steps into a single workflow (the ones that relate to publishing that is)
 - [ ] create a command line tool that can be used to convert a pre-commit configuration file to rustyhook configuration file
 - [ ] expand all built in hooks to include all known hooks from https://pre-commit.com/hooks.html
 - [ ] enable logging to a file or other outputs other than just stdout
@@ -14,7 +15,7 @@ Tasks:
 - [ ] emulate all known pre-commit hooks for use with native execution - all known hooks at https://github.com/pre-commit/pre-commit-hooks
 - [ ] create tests for each hook and complete coverage
 - [ ] replace the npm and nvm install process with fnm if it makes sense to do so
-- [ ] Remove the duplicate code in the github actions by consolidating the build steps and deployment steps into a single workflow
+
 - [ ] Re-evaluate the use of python and other languages in the docker file as they are likely not needed
 - [ ] Update the `.junie/guidelines.md` file to include the new features and rust best practices
 - [ ] Use a mechanism to create and deploy semver compatible releases. Perhaps use cargo-release or some other mechanism to automatically generate release notes and create a tag - trigger a release on tag creation.
