✨ Add GitHub Action for automated release note generation

hyperb1iss · hyperb1iss · commit fb776c56cdcb · 2025-12-16T20:57:02.000-08:00
Introduce action.yml to make Git-Iris available as a reusable GitHub Action
that generates AI-powered release notes in CI/CD pipelines. The action
supports multiple LLM providers, cross-platform binary downloads, and an
optional build-from-source mode for dogfooding unreleased changes.

CICD workflow updates:
- Add Linux ARM64 build target to release matrix
- Refactor release note generation to use the new action with
  build-from-source for self-testing
- Add job to auto-update major version tags (v1, v2) so users can pin
  to stable major versions

Documentation includes action usage examples, input/output reference
tables, and supported platform information.
diff --git a/.github/workflows/cicd.yml b/.github/workflows/cicd.yml
@@ -100,6 +100,11 @@ jobs:
             target: x86_64-unknown-linux-gnu
             binary_name: git-iris
 
+          - build: linux-arm64
+            os: ubuntu-24.04-arm
+            target: aarch64-unknown-linux-gnu
+            binary_name: git-iris
+
           - build: windows-gnu
             os: windows-latest
             target: x86_64-pc-windows-gnu
@@ -349,34 +354,31 @@ jobs:
           ls -la ./release-assets
           echo "::endgroup::"
 
-      - name: 📝 Generate release notes with git-iris
-        env:
-          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+      - name: 🏷️ Get previous tag
+        id: prev_tag
         run: |
-          echo "::group::Generating release notes"
-          if [ -n "$OPENAI_API_KEY" ]; then
-            # Build git-iris locally to generate release notes
-            cargo build --release
-            
-            # Get previous tag
-            PREVIOUS_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
-            
-            if [ -n "$PREVIOUS_TAG" ]; then
-              # Generate release notes using git-iris
-              ./target/release/git-iris release-notes --from "$PREVIOUS_TAG" --to "$GITHUB_REF_NAME" --print > RELEASE_NOTES.md
-              echo "✨ Generated release notes with git-iris"
-            else
-              echo "No previous tag found, using default release notes"
-              echo "# Release $GITHUB_REF_NAME" > RELEASE_NOTES.md
-              echo "See commit history for changes." >> RELEASE_NOTES.md
-            fi
-          else
-            echo "No OpenAI API key available, using default release notes"
-            echo "# Release $GITHUB_REF_NAME" > RELEASE_NOTES.md
-            echo "See commit history for changes." >> RELEASE_NOTES.md
-          fi
-          cat RELEASE_NOTES.md
-          echo "::endgroup::"
+          PREVIOUS_TAG=$(git describe --tags --abbrev=0 HEAD^ 2>/dev/null || echo "")
+          echo "tag=$PREVIOUS_TAG" >> $GITHUB_OUTPUT
+          echo "Previous tag: $PREVIOUS_TAG"
+
+      - name: 📝 Generate release notes with Git-Iris
+        id: release_notes
+        if: steps.prev_tag.outputs.tag != ''
+        uses: ./
+        with:
+          from: ${{ steps.prev_tag.outputs.tag }}
+          to: ${{ github.ref_name }}
+          provider: openai
+          api-key: ${{ secrets.OPENAI_API_KEY }}
+          output-file: RELEASE_NOTES.md
+          build-from-source: "true"
+
+      - name: 📝 Fallback release notes
+        if: steps.prev_tag.outputs.tag == '' || steps.release_notes.outcome == 'failure'
+        run: |
+          echo "# Release ${{ github.ref_name }}" > RELEASE_NOTES.md
+          echo "" >> RELEASE_NOTES.md
+          echo "See [commit history](https://github.com/hyperb1iss/git-iris/commits/${{ github.ref_name }}) for changes." >> RELEASE_NOTES.md
 
       - name: 🚀 Create GitHub Release
         uses: softprops/action-gh-release@v2
@@ -387,3 +389,37 @@ jobs:
           files: |
             ./release-assets/*
           body_path: RELEASE_NOTES.md
+
+  # Auto-update major version tag (v1, v2, etc.) for GitHub Action users
+  update-major-tag:
+    name: 🏷️ Update Major Version Tag
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: create-release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: 📥 Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: 🏷️ Update major version tag
+        run: |
+          # Extract major version from tag (v1.2.3 -> v1)
+          FULL_TAG="${GITHUB_REF_NAME}"
+          MAJOR_TAG=$(echo "$FULL_TAG" | sed -E 's/^(v[0-9]+).*/\1/')
+
+          echo "Full tag: $FULL_TAG"
+          echo "Major tag: $MAJOR_TAG"
+
+          # Configure git
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          # Force update the major version tag
+          git tag -fa "$MAJOR_TAG" -m "Update $MAJOR_TAG to $FULL_TAG"
+          git push origin "$MAJOR_TAG" --force
+
+          echo "✨ Updated $MAJOR_TAG to point to $FULL_TAG"
+          echo "Users can now use: uses: hyperb1iss/git-iris@$MAJOR_TAG"
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -4,8 +4,8 @@ on:
   push:
     branches: [main]
     paths:
-      - 'docs/**'
-      - '.github/workflows/docs.yml'
+      - "docs/**"
+      - ".github/workflows/docs.yml"
   workflow_dispatch:
 
 permissions:
diff --git a/README.md b/README.md
@@ -7,6 +7,7 @@
 [![License](https://img.shields.io/badge/License-Apache%202.0-5E81AC?style=for-the-badge&logo=apache&logoColor=white&color=3B6EA8)](https://opensource.org/licenses/Apache-2.0)
 [![GitHub Release](https://img.shields.io/github/release/hyperb1iss/git-iris.svg?style=for-the-badge&logo=github&logoColor=white&color=9D6DB3)][releases]
 [![Crates.io](https://img.shields.io/crates/v/git-iris.svg?style=for-the-badge&logo=rust&logoColor=white&color=D35D47)][crates]
+[![GitHub Action](https://img.shields.io/badge/GitHub_Action-Release_Notes-5E81AC?style=for-the-badge&logo=github-actions&logoColor=white)](https://github.com/marketplace/actions/git-iris-release-notes)
 [![Rust](https://img.shields.io/badge/rust-stable-EBCB8B?style=for-the-badge&logo=rust&logoColor=white&color=EFBB4D)](https://www.rust-lang.org/)
 [![ko-fi](https://img.shields.io/badge/Ko--fi-Support%20Me-A3BE8C?style=for-the-badge&logo=ko-fi&logoColor=white&color=82B062)](https://ko-fi.com/hyperb1iss)
 
@@ -172,6 +173,56 @@ To build and test the Docker image locally:
 
 For detailed instructions, examples, and CI/CD integration, see our [Docker Usage Guide](docker/README.md).
 
+## 🤖 GitHub Action
+
+Git-Iris is available as a GitHub Action for automated release note generation in your workflows:
+
+```yaml
+- name: Generate release notes
+  uses: hyperb1iss/git-iris@v1
+  id: release_notes
+  with:
+    from: v1.0.0
+    to: v1.1.0
+    provider: openai
+    api-key: ${{ secrets.OPENAI_API_KEY }}
+    output-file: RELEASE_NOTES.md
+
+- name: Create Release
+  uses: softprops/action-gh-release@v2
+  with:
+    body: ${{ steps.release_notes.outputs.release-notes }}
+```
+
+### Action Inputs
+
+| Input | Description | Required | Default |
+|-------|-------------|----------|---------|
+| `from` | Starting Git reference (tag, commit, branch) | Yes | - |
+| `to` | Ending Git reference | No | `HEAD` |
+| `provider` | LLM provider (`openai`, `anthropic`, `google`) | No | `openai` |
+| `model` | Model to use (provider-specific) | No | Provider default |
+| `api-key` | API key for the LLM provider | Yes | - |
+| `output-file` | File path to write release notes | No | - |
+| `version-name` | Explicit version name for release notes | No | - |
+| `custom-instructions` | Custom instructions for generation | No | - |
+| `version` | Git-Iris version to use | No | `latest` |
+
+### Action Outputs
+
+| Output | Description |
+|--------|-------------|
+| `release-notes` | Generated release notes content |
+| `release-notes-file` | Path to output file (if specified) |
+
+### Supported Platforms
+
+The action downloads prebuilt binaries for fast execution:
+- Linux x64 (`ubuntu-latest`)
+- Linux ARM64 (`ubuntu-24.04-arm`)
+- macOS ARM64 (`macos-latest`, runs on x64 via Rosetta)
+- Windows x64 (`windows-latest`)
+
 ## ⚙️ Configuration
 
 Git-Iris offers both global configuration and project-specific configuration options.
diff --git a/action.yml b/action.yml
@@ -0,0 +1,167 @@
+name: "Git-Iris Release Notes"
+description: "Generate AI-powered release notes using Git-Iris"
+author: "hyperb1iss"
+branding:
+  icon: "file-text"
+  color: "purple"
+
+inputs:
+  from:
+    description: "Starting Git reference (tag, commit, or branch)"
+    required: true
+  to:
+    description: "Ending Git reference (defaults to HEAD)"
+    required: false
+    default: "HEAD"
+  provider:
+    description: "LLM provider (openai, anthropic, google)"
+    required: false
+    default: "openai"
+  model:
+    description: "Model to use (provider-specific)"
+    required: false
+  api-key:
+    description: "API key for the LLM provider"
+    required: true
+  output-file:
+    description: "File path to write release notes (optional)"
+    required: false
+  version-name:
+    description: "Explicit version name to use in release notes"
+    required: false
+  custom-instructions:
+    description: "Custom instructions for release note generation"
+    required: false
+  version:
+    description: "Git-Iris version to use (defaults to latest)"
+    required: false
+    default: "latest"
+  build-from-source:
+    description: "Build from source instead of downloading binary (for dogfooding unreleased changes)"
+    required: false
+    default: "false"
+
+outputs:
+  release-notes:
+    description: "Generated release notes content"
+    value: ${{ steps.generate.outputs.release_notes }}
+  release-notes-file:
+    description: "Path to the release notes file (if output-file was specified)"
+    value: ${{ steps.generate.outputs.release_notes_file }}
+
+runs:
+  using: "composite"
+  steps:
+    - name: Determine platform
+      id: platform
+      shell: bash
+      run: |
+        case "${{ runner.os }}-${{ runner.arch }}" in
+          Linux-X64)
+            echo "artifact=git-iris-linux-amd64" >> $GITHUB_OUTPUT
+            echo "binary=git-iris" >> $GITHUB_OUTPUT
+            ;;
+          Linux-ARM64)
+            echo "artifact=git-iris-linux-arm64" >> $GITHUB_OUTPUT
+            echo "binary=git-iris" >> $GITHUB_OUTPUT
+            ;;
+          macOS-ARM64|macOS-X64)
+            # ARM64 binary works on both via Rosetta 2
+            echo "artifact=git-iris-macos-arm64" >> $GITHUB_OUTPUT
+            echo "binary=git-iris" >> $GITHUB_OUTPUT
+            ;;
+          Windows-X64)
+            echo "artifact=git-iris-windows-gnu" >> $GITHUB_OUTPUT
+            echo "binary=git-iris.exe" >> $GITHUB_OUTPUT
+            ;;
+          *)
+            echo "::error::Unsupported platform: ${{ runner.os }}-${{ runner.arch }}"
+            exit 1
+            ;;
+        esac
+
+    - name: Download git-iris binary
+      if: inputs.build-from-source != 'true'
+      shell: bash
+      env:
+        GH_TOKEN: ${{ github.token }}
+      run: |
+        echo "::group::Downloading git-iris"
+
+        # Determine version to download
+        if [ "${{ inputs.version }}" = "latest" ]; then
+          VERSION=$(gh release view --repo hyperb1iss/git-iris --json tagName -q '.tagName')
+        else
+          VERSION="${{ inputs.version }}"
+        fi
+
+        echo "Downloading git-iris $VERSION for ${{ steps.platform.outputs.artifact }}"
+
+        # Download the artifact
+        gh release download "$VERSION" \
+          --repo hyperb1iss/git-iris \
+          --pattern "${{ steps.platform.outputs.artifact }}" \
+          --dir /tmp/git-iris-download
+
+        # The artifact is downloaded as a directory, binary is inside
+        chmod +x "/tmp/git-iris-download/${{ steps.platform.outputs.binary }}"
+        sudo mv "/tmp/git-iris-download/${{ steps.platform.outputs.binary }}" /usr/local/bin/git-iris
+
+        echo "git-iris installed successfully"
+        git-iris --version
+        echo "::endgroup::"
+
+    - name: Build git-iris from source
+      if: inputs.build-from-source == 'true'
+      shell: bash
+      run: |
+        echo "::group::Building git-iris from source"
+        cargo build --release --locked
+        echo "GIT_IRIS_BIN=./target/release/git-iris" >> $GITHUB_ENV
+        echo "::endgroup::"
+
+    - name: Generate release notes
+      id: generate
+      shell: bash
+      env:
+        OPENAI_API_KEY: ${{ inputs.provider == 'openai' && inputs.api-key || '' }}
+        ANTHROPIC_API_KEY: ${{ inputs.provider == 'anthropic' && inputs.api-key || '' }}
+        GOOGLE_API_KEY: ${{ inputs.provider == 'google' && inputs.api-key || '' }}
+        IRIS_PROVIDER: ${{ inputs.provider }}
+        IRIS_MODEL: ${{ inputs.model }}
+        IRIS_INSTRUCTIONS: ${{ inputs.custom-instructions }}
+      run: |
+        echo "::group::Generating release notes"
+
+        # Use built binary or installed command
+        GIT_IRIS="${GIT_IRIS_BIN:-git-iris}"
+
+        # Build command
+        CMD="$GIT_IRIS release-notes --from '${{ inputs.from }}' --to '${{ inputs.to }}' --raw"
+
+        # Add version name if specified
+        if [ -n "${{ inputs.version-name }}" ]; then
+          CMD="$CMD --version-name '${{ inputs.version-name }}'"
+        fi
+
+        # Execute and capture output
+        RELEASE_NOTES=$(eval $CMD)
+
+        # Handle multiline output for GitHub Actions
+        echo "release_notes<<EOF" >> $GITHUB_OUTPUT
+        echo "$RELEASE_NOTES" >> $GITHUB_OUTPUT
+        echo "EOF" >> $GITHUB_OUTPUT
+
+        # Write to file if specified
+        if [ -n "${{ inputs.output-file }}" ]; then
+          echo "$RELEASE_NOTES" > "${{ inputs.output-file }}"
+          echo "release_notes_file=${{ inputs.output-file }}" >> $GITHUB_OUTPUT
+          echo "Release notes written to ${{ inputs.output-file }}"
+        fi
+
+        echo "::endgroup::"
+
+        # Print preview
+        echo "::group::Release Notes Preview"
+        echo "$RELEASE_NOTES"
+        echo "::endgroup::"
