release.yml

name: Release Gem

on:
  workflow_call:
    inputs:
      version:
        description: Optional release version overriding the checked-in version in the standard workflow.
        type: string
      gemspec:
        description: Optional gemspec path; defaults to the only root gemspec.
        type: string
      rubygems-owner:
        description: Optional RubyGems account ID for first publication with a pending trusted publisher.
        type: string
      git-user-name:
        description: Author name for release and next development iteration commits.
        type: string
        default: github-actions[bot]
      git-user-email:
        description: Author email for release and next development iteration commits.
        type: string
        default: github-actions[bot]@users.noreply.github.com
      ruby-version:
        description: Ruby version used to validate and build.
        type: string
        required: true
      timezone:
        description: Timezone for release dates and Git timestamps.
        type: string
        default: UTC
      validate:
        description: Command validating release preconditions; must exit nonzero on failure.
        type: string
        default: bundle exec rake release:validate
      prepare:
        description: Command to prepare release files; INPUT_VERSION is the selected release version.
        type: string
        default: bundle exec rake release:prepare
      test:
        description: Command to test the prepared release.
        type: string
        default: bundle exec rake
      publish:
        description: Idempotent publication command; runs after recovery artifacts are preserved.
        type: string
        default: bundle exec rake release:publish
      bump:
        description: Command to prepare, commit, and push the next development iteration.
        type: string
        default: bundle exec rake release:bump
      success:
        description: Command to run after the release and next development iteration succeed.
        type: string
        default: bundle exec rake release:success
      failure:
        description: Command to run after a release job failure.
        type: string
        default: bundle exec rake release:failure

concurrency:
  group: ruby-gem-release-${{ github.repository }}
  cancel-in-progress: false

jobs:
  release:
    runs-on: ubuntu-latest
    environment: release
    env:
      INPUT_VERSION: ${{ inputs.version }}
      INPUT_GEMSPEC_PATH: ${{ inputs.gemspec }}
      DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
      GIT_USER_NAME: ${{ inputs.git-user-name }}
      GIT_USER_EMAIL: ${{ inputs.git-user-email }}
      RUBYGEMS_OWNER_ID: ${{ inputs.rubygems-owner }}
      TZ: ${{ inputs.timezone }}
    steps:
      - uses: actions/checkout@v7
        id: checkout
        with:
          fetch-depth: 0
      - uses: ruby/setup-ruby@v1
        id: setup_ruby
        with:
          ruby-version: ${{ inputs.ruby-version }}
          bundler-cache: true
      - name: Capture Release Context
        id: capture_release_context
        env:
          RELEASE_STEP_ID: capture_release_context
        run: bundle exec rake release:workflow:capture
      - name: Validate Release
        id: validate_release
        env:
          RELEASE_COMMAND: ${{ inputs.validate }}
          RELEASE_STEP_ID: validate_release
          RELEASE_STEPS_JSON: ${{ toJSON(steps) }}
        run: bash -euo pipefail -c "$RELEASE_COMMAND"
      - name: Prepare Release
        id: prepare_release
        env:
          RELEASE_COMMAND: ${{ inputs.prepare }}
          RELEASE_STEP_ID: prepare_release
          RELEASE_STEPS_JSON: ${{ toJSON(steps) }}
        run: bash -euo pipefail -c "$RELEASE_COMMAND"
      - name: Resolve Prepared Version
        id: resolve_prepared_version
        env:
          RELEASE_STEP_ID: resolve_prepared_version
        run: bundle exec rake release:workflow:resolve
      - name: Test Release
        id: test_release
        env:
          RELEASE_COMMAND: ${{ inputs.test }}
          RELEASE_STEP_ID: test_release
          RELEASE_STEPS_JSON: ${{ toJSON(steps) }}
        run: bash -euo pipefail -c "$RELEASE_COMMAND"
      - name: Checkpoint Release
        id: checkpoint_release
        env:
          RELEASE_STEP_ID: checkpoint_release
        run: bundle exec rake release:workflow:checkpoint
      - name: Preserve Release Artifacts
        id: preserve_release_artifacts
        uses: actions/upload-artifact@v7
        with:
          name: release-gem-${{ env.RELEASE_VERSION }}-${{ github.run_id }}-${{ github.run_attempt }}
          path: |
            ${{ runner.temp }}/release.gem
            ${{ runner.temp }}/release.json
            ${{ runner.temp }}/release.bundle
          if-no-files-found: error
          retention-days: 30
      - name: Publish Release
        id: publish_release
        env:
          GH_TOKEN: ${{ github.token }}
          RELEASE_COMMAND: ${{ inputs.publish }}
          RELEASE_STEP_ID: publish_release
          RELEASE_STEPS_JSON: ${{ toJSON(steps) }}
        run: bash -euo pipefail -c "$RELEASE_COMMAND"
      - name: Prepare Next Development Iteration
        id: prepare_next_development_iteration
        env:
          RELEASE_COMMAND: ${{ inputs.bump }}
          RELEASE_STEP_ID: prepare_next_development_iteration
          RELEASE_STEPS_JSON: ${{ toJSON(steps) }}
        run: bash -euo pipefail -c "$RELEASE_COMMAND"
      - name: Run Release Success Callback
        id: release_success_callback
        if: ${{ success() }}
        env:
          RELEASE_COMMAND: ${{ inputs.success }}
          RELEASE_STEP_ID: release_success_callback
          RELEASE_STEPS_JSON: ${{ toJSON(steps) }}
        run: bash -euo pipefail -c "$RELEASE_COMMAND"
      - name: Determine Release Failure Phase
        id: determine_release_failure_phase
        if: ${{ failure() && steps.setup_ruby.outcome == 'success' }}
        env:
          RELEASE_STEPS_JSON: ${{ toJSON(steps) }}
        run: bundle exec rake release:workflow:failure_phase
      - name: Run Release Failure Callback
        id: release_failure_callback
        if: ${{ failure() && steps.setup_ruby.outcome == 'success' }}
        env:
          RELEASE_COMMAND: ${{ inputs.failure }}
          RELEASE_STEP_ID: release_failure_callback
          RELEASE_STEPS_JSON: ${{ toJSON(steps) }}
        run: bash -euo pipefail -c "$RELEASE_COMMAND"