-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ci: workflow to check if generated docs are updated
- Loading branch information
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
name: Generated Files are Updated | ||
on: | ||
pull_request: | ||
branches: | ||
- "*" | ||
|
||
jobs: | ||
build: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout code | ||
uses: actions/checkout@v3 | ||
|
||
- name: Setup Node.js environment | ||
uses: actions/setup-node@v2 | ||
with: | ||
node-version: "18" | ||
|
||
- name: Install dependencies | ||
run: | | ||
sudo apt-get update | ||
sudo apt-get install -y jq unzip | ||
yarn install | ||
- name: Generate docs | ||
run: | | ||
yarn docs | ||
- name: Check for changes | ||
run: | | ||
if git diff --exit-code --ignore-space-change --ignore-all-space --ignore-cr-at-eol -- pkg docs; then | ||
echo "Generated files are up-to-date." | ||
else | ||
echo "::error::Generated files are not up-to-date. Please run 'yarn docs' locally and commit any changes." | ||
exit 1 | ||
fi |