Redocly Reunite CI/CD push GitHub Action

Use a GitHub Action for pushing remote content to the Redocly Reunite project. Users with their projects hosted in their own GitHub accounts, but without the Redocly GitHub application installed can use this action in the repository that holds the remote content to push their changes to the Reunite platform. This action has some advantages over using the push command because it also sets corresponding commit statuses for project deployments and scorecards.

The best way to get started with the GitHub action is to copy the code snippet presented to you when you add a remote content source to your project. When you add a new Remote from CI/CD, you'll be presented with a starter template for the action that you can use.

Options

Option	Type	Description
replace	replace	replace
organization	string	REQUIRED. Your Redocly organization slug.
project	string	REQUIRED. Your Redocly project slug.
mountPath	string	REQUIRED. Path to folder where you files should be pushed. For example `src/docs/api`.
files	string	REQUIRED. Files/folders list within your repo, separated by spaces. For example `openapi-files src/redocly-museum.yaml`.
githubToken	string	GitHub token for setting commit status. By default the existing `${{ github.token }}` is used.
domain	URL	Redocly domain (if your Redocly app is hosted somewhere other than the default at `https://app.cloud.redocly.com`).
maxExecutionTime	integer	Max execution time in seconds. If the deployment is not successful within this time, the action will fail. Default value: '1200' (20 minutes)

Authorization

This action requires authorization using an API key for your organization. See Manage organization-wide API keys to obtain and update your API key.

Store the API key as an environment variable called REDOCLY_AUTHORIZATION. The action will read this secret value from the environment when it executes.

Permissions

This action requires:

contents: read - for reading files for push.
statuses: write - for writing commit statuses.

Examples

The following example shows a GitHub workflow that pushes a src/redocly-museum.yaml file from the remote content repo to the src/docs/museum folder inside an example-project in Reunite.

The action will run for pushes to any branch. But Redocly API will detect pushes to main branch and non main branch and triggers corresponding preview or production deployments.

.github/workflows/redocly-push.yaml

name: Push to Redocly Reunite (GH Workflow Example)

on:
  push:
    branches:
      - '**'

jobs:
  reunite-push:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      statuses: write
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Redocly Reunite push
        uses: redocly/reunite-push-action@v1
        with:
          organization: 'example-org'
          project: 'example-project'
          mountPath: 'src/docs/museum'
          files: 'src/redocly-museum.yaml'
        env:
          REDOCLY_AUTHORIZATION: ${{ secrets.REDOCLY_API_KEY }}

When the action runs, it updates with the build statuses of any scorecards and the project itself.

Resources

Add remote content to a Reunite project.
If you're not a GitHub user, the push CLI command is an alternative way to send remote content into a Reunite project.