Optic Auto API Documentation Commentator

See your latest API Specification for every single pull request

Prerequisites

An Optic Project. Make one here!

Usage

Simply add Optic to your pull request workflow. Requires GITHUB_TOKEN to comment on prs.

.github/workflows/optic.yml

name: Optic Pull Request Bot
on: [pull_request]
jobs:
  optic_pr:
    runs-on: ubuntu-latest
    steps:
      - name: Optic PR Bot
        uses: trulyronak/gitbot@beta
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Inputs

`head`

The branch to compare with base. Defaults to ${{ github.head_ref }}, or the branch that spurred the pull_request event.

`repository`

The repository to be running this on. Defaults to the current repository.