Skip to content

Only redeploy docs when package version changes #141

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.

Sign up for GitHub

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
hectorhdzg merged 1 commit into from
May 13, 2026
+28 −0
Merged

Only redeploy docs when package version changes #141

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 28 additions & 0 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ name: Deploy TypeDoc
on:
push:
branches: [main]
paths:
- 'package.json'
workflow_dispatch:

permissions:
Expand All @@ -15,8 +17,34 @@ concurrency:
cancel-in-progress: false

jobs:
check-version:
name: Check version change
runs-on: ubuntu-latest
outputs:
changed: ${{ github.event_name == 'workflow_dispatch' || steps.version.outputs.changed == 'true' }}
steps:
- name: Check out repository
uses: actions/checkout@v4
with:
fetch-depth: 2

- name: Check if version changed
id: version
run: |
CURRENT=$(node -p "require('./package.json').version")
if ! git show HEAD~1:package.json > prev-package.json 2>/dev/null; then
echo "changed=true" >> "$GITHUB_OUTPUT"
exit 0
fi
PREVIOUS=$(node -p "require('./prev-package.json').version")
if [ "$CURRENT" != "$PREVIOUS" ]; then
echo "changed=true" >> "$GITHUB_OUTPUT"
fi

build:
name: Generate docs
needs: check-version
if: needs.check-version.outputs.changed == 'true'
runs-on: ubuntu-latest

steps:
Expand Down
Loading