Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
69 changes: 69 additions & 0 deletions .github/workflows/oas-update.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: OAS Update

on:
workflow_dispatch:
schedule:
# Runs at 7:00 AM UTC every day
- cron: '0 7 * * *'

permissions:
contents: write
pull-requests: write

jobs:
oas-update:
runs-on: ubuntu-latest
steps:
- name: Check out repository code
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0

- name: Set up Node
uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
with:
node-version: 20
cache: 'npm'

- name: Install dependencies
run: npm ci

- name: Run OAS update
run: npm run oas:update

- name: Stage changes
run: |
# Stage api-reference changes
git add "**/api-reference/**"
# Stage docs.json
git add docs.json
git status

- name: Check for changes in api-reference
id: check_changes
run: |
if git diff --cached --quiet; then
echo "No changes detected in api-reference or docs.json."
echo "changed=false" >> $GITHUB_OUTPUT
else
echo "Changes detected in api-reference or docs.json."
echo "changed=true" >> $GITHUB_OUTPUT
echo "Changes found:"
git diff --cached --name-only
fi

- name: Create Pull Request
if: steps.check_changes.outputs.changed == 'true'
uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
with:
commit-message: 'chore: update OAS spec'
title: 'chore: update OAS specification'
body: |
This PR was automatically generated to update the OpenAPI Specification.

Changes detected in:
- api-reference directory
- docs.json
branch: 'chore/oas-update'
delete-branch: true
labels: |
automated
api-reference
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.idea/*
**/.DS_Store

node_modules/
dist/
2 changes: 2 additions & 0 deletions .mintlifyignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
scripts/
node_modules/
Loading