fix: reorder release workflow — run typedoc before tests#420
Merged
Conversation
- Move API doc generation (typedoc) before unit tests in release workflow so api/ directory exists when sitemap-generation tests run - Split API doc generation from copying to docs/ (generation before tests, copying after clean step) - Make API Documentation Coverage tests conditional on api/ directory existence so tests pass in both development and release contexts Co-authored-by: pethers <[email protected]>
Co-authored-by: pethers <[email protected]>
Copilot
AI
changed the title
[WIP] Fix release flow for coverage documentation
fix: reorder release workflow — run typedoc before tests
Feb 21, 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.
Release workflow fails because
sitemap-generation.test.tsexpects API doc URLs in the sitemap, butnpm run typedocruns afternpm run coverage. Theapi/directory doesn't exist at test time → 4 test failures.Workflow reordering (
.github/workflows/release.yml)npm run typedocbeforenpm run coveragesoapi/exists when sitemap tests rundocs/(after clean step)Test resilience (
tests/sitemap-generation.test.ts)api/directory is absent (normal dev), validate fully when present (release)💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.