release.yml

# We use this singular file for all of our releases because we can only specify
# a singular GitHub workflow file in npm's Trusted Publishing configuration.
# See https://docs.npmjs.com/trusted-publishers for more info.
#
# Specific jobs only run on the proper trigger:
#
# - Change file driven stable releases (push to release/hotfix branches)
# - Experimental releases (from a workflow_dispatch trigger)

name: 🚢 Release/Publish

on:
  push:
    branches:
      - "release"
      - "hotfix"
  workflow_dispatch:
    inputs:
      branch:
        required: true
        description: Experimental release branch

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  check:
    name: Check release readiness
    if: github.repository == 'remix-run/react-router' && github.event_name == 'push'
    runs-on: ubuntu-latest
    outputs:
      has_change_files: ${{ steps.check.outputs.has_change_files }}
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Check for change files
        id: check
        run: |
          # Look for change files in any package's .changes directory (excluding README.md)
          change_files=$(find packages/*/.changes -name "*.md" ! -name "README.md" 2>/dev/null)
          if [ -n "$change_files" ]; then
            echo "Change files found (blocking publish):"
            echo "$change_files"
            echo "has_change_files=true" >> $GITHUB_OUTPUT
          else
            echo "No change files found, proceeding to publish."
            echo "has_change_files=false" >> $GITHUB_OUTPUT
          fi

  pull_request:
    name: Open pull request
    needs: check
    if: needs.check.outputs.has_change_files == 'true'
    runs-on: ubuntu-latest
    permissions:
      contents: write # enable pushing changes to the origin
      pull-requests: write # enable opening a PR for the release
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          fetch-depth: 0
          token: ${{ secrets.FORMAT_PAT }}

      - name: Install pnpm
        uses: pnpm/action-setup@v5

      - name: Install Node.js
        uses: actions/setup-node@v6
        with:
          node-version: 24 # Needed to run typescript scripts directly
          package-manager-cache: false

      - name: Install dependencies
        run: pnpm install --frozen-lockfile

      - name: Update PR
        run: pnpm changes:pr
        env:
          GITHUB_TOKEN: ${{ secrets.FORMAT_PAT }}

  publish:
    name: Publish
    needs: check
    if: needs.check.outputs.has_change_files == 'false'
    runs-on: ubuntu-latest
    permissions:
      contents: write # enable pushing changes to the origin
      id-token: write # enable generation of an ID token for publishing
    steps:
      - name: ⬇️ Checkout repo
        uses: actions/checkout@v6

      - name: 📦 Setup pnpm
        uses: pnpm/action-setup@v6

      - name: ⎔ Setup node
        uses: actions/setup-node@v6
        with:
          node-version: 24 # Needed for npm@11 for Trusted Publishing
          package-manager-cache: false

      - name: 📥 Install deps
        run: pnpm install --frozen-lockfile

      - name: Build packages
        run: pnpm build

      - name: Publish to npm and create releases
        run: pnpm changes:publish
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

  comment:
    name: 📝 Comment on released issues/pull requests
    needs: publish
    runs-on: ubuntu-latest
    permissions:
      issues: write # enable commenting on released issues
      pull-requests: write # enable commenting on released pull requests
    steps:
      - name: ⬇️ Checkout repo
        uses: actions/checkout@v6
        with:
          fetch-depth: 0

      - name: 📦 Setup pnpm
        uses: pnpm/action-setup@v6

      - name: ⎔ Setup node
        uses: actions/setup-node@v6
        with:
          node-version: 24 # Needed for node TS support
          package-manager-cache: false

      - name: 📥 Install deps
        run: pnpm install --frozen-lockfile

      - name: 📝 Comment on released issues and pull requests
        env:
          GH_TOKEN: ${{ github.token }}
        run: pnpm run release-comments

  experimental-release:
    name: 🧪 Experimental Release
    if: github.repository == 'remix-run/react-router' && github.event_name == 'workflow_dispatch'
    runs-on: ubuntu-latest
    permissions:
      contents: write # enable pushing changes to the origin
      id-token: write # enable generation of an ID token for publishing
    steps:
      - name: ⬇️ Checkout repo
        uses: actions/checkout@v6
        with:
          ref: ${{ github.event.inputs.branch }}
          # checkout using a custom token so that we can push later on
          token: ${{ secrets.GITHUB_TOKEN }}
          fetch-depth: 0

      - name: 📦 Setup pnpm
        uses: pnpm/action-setup@v6

      - name: ⎔ Setup node
        uses: actions/setup-node@v6
        with:
          node-version: 24 # Needed for npm@11 for Trusted Publishing
          package-manager-cache: false

      - name: 📥 Install deps
        run: pnpm install --frozen-lockfile

      - name: ⤴️ Update version
        run: |
          git config --local user.email "hello@remix.run"
          git config --local user.name "Remix Run Bot"
          pnpm run experimental:version
          git push origin --tags

      - name: 🏗 Build
        run: pnpm build

      - name: 🚀 Publish
        run: pnpm run experimental:publish