readme-openapi-docs-sync.yml

# This GitHub Actions workflow was auto-generated by the `rdme` cli on 2024-03-28T13:15:31.687Z
# You can view our full documentation here: https://docs.readme.com/docs/rdme
name: Publish API Docs

on:
  push:
    branches:
      # This workflow will run every time you push code to the following branch: `master`
      # Check out GitHub's docs for more info on configuring this:
      # https://docs.github.com/actions/using-workflows/events-that-trigger-workflows
      - master
    paths:
      - 'docs/openAPI.json'

jobs:
  rdme-openapi:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repo
        uses: actions/checkout@v3

      - name: Run validation on docs
        uses: readmeio/rdme@v8
        with:
          rdme: openapi:validate docs/openAPI.json 

      - name: Run `openapi` command (dry run)
        uses: readmeio/rdme@v8
        with:
          rdme: openapi docs/openAPI.json --key=${{ secrets.README_API_KEY }} --id=${{ secrets.README_API_DEFINITIONS_ID }} --dryRun
          
      - name: Run `openapi` command
        uses: readmeio/rdme@v8
        with:
          rdme: openapi docs/openAPI.json --key=${{ secrets.README_API_KEY }} --id=${{ secrets.README_API_DEFINITIONS_ID }}