pull_request_mintlify.yml

name: Build Stainless SDKs (Mintlify)

on:
  pull_request:
    types: [opened, synchronize, reopened]
  push:
    # Set this to the branch of the repository that the `main` Stainless branch
    # of your project gets its OpenAPI spec from. This is usually the default
    # branch of your repository.
    branches: [main]
  workflow_dispatch:

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

env:
  # Stainless organization name.
  STAINLESS_ORG: YOUR_ORG

  # Stainless project name.
  STAINLESS_PROJECT: YOUR_PROJECT

  # Path to your OpenAPI spec.
  OAS_PATH: YOUR_OAS_PATH

  # Path to your Stainless config. Optional; only provide this if you prefer
  # to maintain the ground truth Stainless config in your own repo.
  CONFIG_PATH: YOUR_CONFIG_PATH

  # When to fail the job based on build conclusion.
  # Options: "never" | "note" | "warning" | "error" | "fatal".
  FAIL_ON: error

  # Name of your Mintlify GitHub repo, e.g. `stainless-api/docs`.
  MINTLIFY_DOCS_REPO: YOUR_MINTLIFY_DOCS_REPO

  # Email associated with the GitHub token, for committing to the Mintlify repo.
  GITHUB_TOKEN_EMAIL: YOUR_EMAIL

  # Name associated with the GitHub token, for committing to the Mintlify repo.
  GITHUB_TOKEN_NAME: YOUR_NAME

  # In your repo secrets, configure:
  # - API_TOKEN_GITHUB: a GitHub personal access token with permissions to
  #   write to the Mintlify repo

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      pull-requests: write
      id-token: write
    steps:
      - name: Checkout repository
        uses: actions/checkout@v6

      - name: Run build
        id: build
        uses: stainless-api/upload-openapi-spec-action/build@v1
        with:
          org: ${{ env.STAINLESS_ORG }}
          project: ${{ env.STAINLESS_PROJECT }}
          oas_path: ${{ env.OAS_PATH }}
          config_path: ${{ env.CONFIG_PATH }}
          fail_on: ${{ env.FAIL_ON }}

      - name: Push spec to Mintlify
        if: github.event_name == 'push'
        uses: dmnemec/copy_file_to_another_repo_action@main
        env:
          API_TOKEN_GITHUB: ${{ secrets.API_TOKEN_GITHUB }}
        with:
          source_file: ${{ steps.build.outputs.documented_spec_path }}
          destination_repo: ${{ env.MINTLIFY_DOCS_REPO }}
          destination_folder: openapi-specs
          user_email: ${{ env.GITHUB_TOKEN_EMAIL }}
          user_name: ${{ env.GITHUB_TOKEN_NAME }}
          commit_message: Auto-updates from Stainless