Only redeploy docs when package version changes#141
Merged
Conversation
Add a version check job that compares the version field in package.json between the current and previous commit. Docs are only rebuilt and deployed when the version actually changes, not on every PR merge. Manual workflow_dispatch still triggers a full deploy.
rads-1996
requested review from
JacksonWeber,
MSNev,
hectorhdzg,
jeremydvoss and
lzchen
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the GitHub Pages TypeDoc deployment workflow so documentation is rebuilt/deployed only when the package.json version changes (or when manually triggered), reducing unnecessary doc deployments on merges to main.
Changes:
- Restricts the workflow trigger on
pushto only run whenpackage.jsonchanges. - Adds a
check-versionjob that comparespackage.jsonversion against the previous commit and gates the docs build/deploy. - Ensures
workflow_dispatchcontinues to force a full docs build/deploy.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
JacksonWeber
approved these changes
May 13, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a version check job that compares the version field in package.json between the current and previous commit. Docs are only rebuilt and deployed when the version actually changes, not on every PR merge. Manual workflow_dispatch still triggers a full deploy.