Skip to content

Remove auto-commit API report workflow #8808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 3, 2025
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 31 additions & 23 deletions .github/workflows/check-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,34 @@ jobs:
runs-on: ubuntu-latest

steps:
- name: Checkout Repo
uses: actions/checkout@v4
with:
# get all history for the diff
fetch-depth: 0
- name: Set up Node (20)
uses: actions/setup-node@v4
with:
node-version: 22.10.0
- name: Yarn install
run: yarn
- name: Run doc generation
run: yarn docgen:all
- name: Check for changes in docs-devsite dir (fail if so)
run: |
if [[ -n "$(git status docs-devsite --porcelain)" ]]; then
echo "Unstaged changes detected:"
git status -s
exit 1
fi
- name: Reference documentation needs to be updated. See message below.
if: ${{ failure() }}
run: echo "Changes in this PR affect the reference docs. Run \`yarn docgen:all\` locally to regenerate docs and add them to this PR."
- name: Checkout Repo
uses: actions/checkout@v4
with:
# get all history for the diff
fetch-depth: 0
- name: Set up Node (20)
uses: actions/setup-node@v4
with:
node-version: 22.10.0
- name: Yarn install
run: yarn
- name: Run doc generation
run: yarn docgen:all
# Fail first if there are docs-devsite changes since running yarn docgen:all
# will also regenerate any API report changes.
- name: Check for changes in docs-devsite dir (fail if so)
run: |
if [[ -n "$(git status docs-devsite --porcelain)" ]]; then
echo "Unstaged changes detected in docs-devsite/:"
git status -s
echo "Changes in this PR affect the reference docs or API reports. Run \`yarn docgen:all\` locally to regenerate the changed files and add them to this PR."
exit 1
fi
- name: Check for changes in common/api-review dir (fail if so)
run: |
if [[ -n "$(git status common/api-review --porcelain)" ]]; then
echo "Unstaged changes detected in api-report(s):"
git status -s
echo "Changes in this PR affect the API reports. Run \`yarn build\` locally to regenerate the API reports and add them to this PR."
exit 1
fi
48 changes: 0 additions & 48 deletions .github/workflows/update-api-reports.yml

This file was deleted.

Loading