sync-openapi

A GitHub Action to sync files from your source repository to a target repository (like fern-config).

Usage

1. In your your source repo, create a file named sync-openapi.yml in .github/workflows/.
2. Include the following contents in the sync-openapi.yml you just created:

name: Sync OpenAPI Specs # can be customized
on:
  workflow_dispatch:
  push:
    branches:
      - main
jobs:
  sync:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Sync OpenAPI spec to target repo
        uses: fern-api/sync-openapi@v0
        with:
          repository: <your-org>/<your-target-repo>
          token: ${{ secrets.<PAT_TOKEN_NAME> }}
          files: |
            - source: path/to/file1/in/this/repo.yml # note: all file paths are relative to repository root
              destination: path/to/file1/in/destination/repo.yml
            - source: path/to/file2/in/this/repo.yml
              destination: path/to/file2/in/destination/repo.yml

                ....

          branch: main
          auto_merge: true # note: branch = main with auto_merge = false will cause an error

Inputs

Input	Description	Required	Default
repository	Target repository in format org/repo	Yes	-
files	Array of mappings with source and destination paths	Yes	-
token	GitHub token for authentication	No	${{ github.token }}
branch	Branch to push to in the target repository	Yes	-
auto_merge	Will push directly to the specified branch when true, will create a PR from the specified base branch onto main if false.	No	false

Required Permissions

The GitHub token used for this action must have:

1. Read access to the source repository
2. Read/Write access to Contents and Pull requests for the target repository

Adding a Token for GitHub Actions

1. Generate a fine-grained https://github.com/settings/personal-access-tokens token with the above-mentioned permissions
2. Go to Settings -> Secrets and variables -> Actions and click on New repository secret
3. Name your token (i.e. OPENAPI_SYNC_TOKEN) and paste in the PAT token generated above
4. Replace <PAT_TOKEN_NAME> in the example YAML configuration with your token name.