Skip to content

Merge branch 'main' into v3 #251

Merge branch 'main' into v3

Merge branch 'main' into v3 #251

Workflow file for this run

name: Docs
on:
push:
branches:
- main
- v3
paths:
- "api/**"
- "docs/api/**"
workflow_dispatch:
jobs:
sync:
name: Sync
runs-on: ubuntu-22.04
steps:
- name: Check out code
uses: actions/checkout@v4
- name: Detect PMM version and API ID
run: |
# For reference:
# PMM 2: VERSION=v2, ID=626badcabbc59c02acc1a53f
# PMM 3: VERSION=v3, ID=622892a957a7410330bc6184
export VERSION=$(cat api/swagger/swagger.json | jq -r '.info.version')
export ID=$(cat api/swagger/swagger.json | jq -r '."x-readme-id"')
echo "VERSION=$VERSION" >> $GITHUB_ENV
echo "ID=$ID" >> $GITHUB_ENV
- name: Provision rdme
run: npm install -g rdme
- name: Sync API spec
run: rdme openapi ./api/swagger/swagger.json --id=${{ env.ID }} --key=${{ secrets.README_TOKEN }}
- name: Sync Markdown docs
run: rdme docs docs/api --version=${{ env.VERSION }} --key=${{ secrets.README_TOKEN }}