prepare-release-pr.yml

name: Prepare Release PR

on:
  workflow_dispatch:
    inputs:
      releaseType:
        description: 'The type of release to prepare a PR for.'
        required: true
        type: choice
        default: 'stable'
        options:
          - stable
          - alpha
          - beta
          - rc

permissions: {} # we use a personal access token to push the branch and create the PR

jobs:
  prepare_release_pr:
    name: Prepare Release PR
    runs-on: ubuntu-latest
    timeout-minutes: 10

    steps:
      - name: Checkout
        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
        with:
          fetch-depth: 0
          token: ${{ secrets.GH_TOKEN }}

      - name: Install pnpm
        uses: pnpm/action-setup@fe02b34f77f8bc703788d5817da081398fad5dd2 # v4.0.0

      - name: Set node version to 22
        uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
        with:
          node-version: 22
          cache: 'pnpm'

      - name: Install deps
        run: pnpm install
        env:
          CYPRESS_INSTALL_BINARY: 0

      - name: Run release
        run: |
          git config user.name "FakerJS Bot"
          git config user.email "github-bot@fakerjs.dev"
          if [ $RELEASE_TYPE = 'stable' ]; then
            pnpm run release
          else
            pnpm run release --prerelease $RELEASE_TYPE
          fi
          RELEASE_VERSION=$(jq -r '.version' package.json)
          echo "RELEASE_VERSION=$RELEASE_VERSION" >> $GITHUB_ENV
        env:
          RELEASE_TYPE: ${{ github.event.inputs.releaseType }}

      - name: Switch to and push release branch
        run: |
          RELEASE_BRANCH="chore/release/$RELEASE_VERSION"
          echo "RELEASE_BRANCH=$RELEASE_BRANCH" >> $GITHUB_ENV
          git switch -c $RELEASE_BRANCH
          git push origin $RELEASE_BRANCH -f

      - name: Create draft PR
        run: |
          gh pr create \
            --base $GITHUB_REF_NAME \
            --head $RELEASE_BRANCH \
            --draft \
            --title "chore(release): $RELEASE_VERSION" \
            --body "
          Release for $RELEASE_VERSION

          - [ ] Completed manual changes/tasks for this release

          ---

          - Checklist: TODO add link to issue
          "
        env:
          GH_TOKEN: ${{ secrets.GH_TOKEN }}