AutoLibrary/.github/workflows/commit-release.yml

name: Commit Release

# This workflow commits version changes in 'ALVersionInfo.py' (get from artifacts) and
# creates/moves the release tag to this new release commit.
#
# It is triggered when called by the release workflow.

on:
  workflow_call:
    inputs:
      tag_name:
        description: 'Tag name to create/move (e.g., v1.0.0 or v1.0.0-rc1)'
        required: true
        type: string
      version:
        description: 'Version number for commit message'
        required: true
        type: string
      file_path:
        description: 'File path to commit'
        required: true
        type: string
      create_tag:
        description: 'Whether to create new tag (true) or move existing tag (false)'
        required: false
        type: string
        default: 'false'
      is_rc:
        description: 'Whether this is a release candidate (pre-release)'
        required: false
        type: string
        default: 'false'
      ref:
        description: 'Git ref to checkout (release branch)'
        required: true
        type: string
    outputs:
      tag_name:
        description: 'The tag name created/moved'
        value: ${{ inputs.tag_name }}
      version:
        description: 'Version number for commit message'
        value: ${{ inputs.version }}
      new_commit_sha:
        description: 'The new commit SHA after creating/moving the tag'
        value: ${{ jobs.commit-release.outputs.new_commit_sha }}
      branch_name:
        description: 'The branch name where the commit was made'
        value: ${{ jobs.commit-release.outputs.branch_name }}

jobs:
  commit-release:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    outputs:
      new_commit_sha: ${{ steps.commit_info.outputs.commit_sha }}
      branch_name: ${{ steps.push_release.outputs.branch_name }}

    steps:
    - name: Checkout code
      uses: actions/checkout@v6
      with:
        ref: ${{ inputs.ref }}
        fetch-depth: 0

    # here we download the commit version of ALVersionInfo.py from artifacts
    # and replace the original file with it.
    - name: Download commit version of ALVersionInfo.py
      uses: actions/download-artifact@v6
      with:
        name: updated-version-info-for-commit
        path: downloaded-file/

    - name: Replace file with updated version
      run: |
        FILE_PATH="${{ inputs.file_path }}"
        FILE_NAME=$(basename "$FILE_PATH")
        TARGET_DIR=$(dirname "$FILE_PATH")

        mkdir -p "$TARGET_DIR"
        cp "downloaded-file/$FILE_NAME" "$FILE_PATH"

        echo "✓ File replaced: $FILE_PATH"
        echo ""
        echo "========================================"
        echo "Updated file content"
        echo "========================================"
        cat  "$FILE_PATH"
        echo "========================================"

    - name: Commit changes
      id: commit_changes
      run: |
        git config --local user.email "github-actions[bot]@users.noreply.github.com"
        git config --local user.name "github-actions[bot]"

        FILE_PATH="${{ inputs.file_path }}"
        VERSION="${{ inputs.version }}"

        if [ ! -f "$FILE_PATH" ]; then
          echo "✗ Error: File $FILE_PATH not found"
          exit 1
        fi

        git add "$FILE_PATH"
        git commit -m "chore(release): v${VERSION} [auto release commit]"
        echo "✓ Changes committed"

    - name: Push to release branch
      id: push_release
      run: |
        # Get the release branch name from the input ref
        BRANCH_NAME=$(echo "${{ inputs.ref }}" | sed 's|refs/heads/||')

        if [ -z "$BRANCH_NAME" ]; then
          echo "✗ Error: Could not determine branch name from ref: ${{ inputs.ref }}"
          exit 1
        fi

        echo "Pushing to branch: ${BRANCH_NAME}"
        git push origin HEAD:${BRANCH_NAME}
        echo "✓ Changes pushed to ${BRANCH_NAME}"

        # Output branch name for downstream jobs
        echo "branch_name=$BRANCH_NAME" >> $GITHUB_OUTPUT

    - name: Create tag for release
      if: ${{ inputs.create_tag == 'true' }}
      run: |
        TAG_NAME="${{ inputs.tag_name }}"
        IS_RC="${{ inputs.is_rc }}"

        echo "Creating new tag ${TAG_NAME} at this commit..."
        echo "Release type: $([ "$IS_RC" = "true" ] && echo "Release Candidate (Pre-release)" || echo "Stable Release")"
        git tag ${TAG_NAME}
        git push origin ${TAG_NAME}
        echo "✓ Tag ${TAG_NAME} created at commit $(git rev-parse --short HEAD)"

    - name: Move tag to new release commit
      if: ${{ inputs.create_tag != 'true' }}
      run: |
        TAG_NAME="${{ inputs.tag_name }}"

        echo "Moving tag ${TAG_NAME} to the new commit..."
        git tag -f ${TAG_NAME}
        git push origin ${TAG_NAME} --force
        echo "✓ Tag ${TAG_NAME} moved to commit $(git rev-parse --short HEAD)"

    - name: Output commit info
      id: commit_info
      run: |
        COMMIT_SHA=$(git rev-parse --short HEAD)
        echo "commit_sha=$COMMIT_SHA" >> $GITHUB_OUTPUT
        echo "✓ New commit SHA: $COMMIT_SHA"
        echo "## Commit Release Summary" >> $GITHUB_STEP_SUMMARY
        echo "" >> $GITHUB_STEP_SUMMARY
        echo "========================================" >> $GITHUB_STEP_SUMMARY
        echo "- Version: ${{ inputs.version }}" >> $GITHUB_STEP_SUMMARY
        echo "- Tag: ${{ inputs.tag_name }}" >> $GITHUB_STEP_SUMMARY
        echo "- Commit SHA: $COMMIT_SHA" >> $GITHUB_STEP_SUMMARY