build(release): run only docs:typedoc in preversion#10
Merged
Conversation
- The preversion hook ran the full `npm run docs` (typedoc + VitePress build). The VitePress build emits a gitignored artifact (docs/.vitepress/dist) that is never committed and is rebuilt + deployed by the Docs CI workflow, so running it during `npm version` is pure redundancy. - It also breaks `npm version` on a OneDrive-synced working tree, where the cloud-dehydrated .vitepress files fail to read/build. - Keep only docs:typedoc, which regenerates and stages the committed docs/api markdown. The published site is still built by CI on push to main. build with cc
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
1 participant
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.
What
The
preversionnpm hook ran the fullnpm run docs(typedoc + VitePress build) before everynpm version. That is wrong on two counts:docs/.vitepress/dist, which is gitignored and never committed, and the published site is rebuilt + deployed by the Docs CI workflow on push tomain. Building it duringnpm versionis pure redundancy.npm versionon a OneDrive-synced working tree: the cloud-dehydrated.vitepressfiles fail to read/build, so the hook (and thus the release) aborts. The 0.15.0 release had to route around it with a manual bump.Change
preversionnow runs onlydocs:typedoc, which regenerates and stages the committeddocs/api/markdown (the hook's actual purpose). The site is still built and deployed by CI.build with cc