ci(docs): auto-publish TypeDoc API reference to gh-pages#72
Conversation
Miracle656
left a comment
Miracle656
left a comment
There was a problem hiding this comment.
The PR title and Closes #62 claim TypeDoc auto-publish to gh-pages, but the actual diff is only:
Dockerfile : 1 line of trailing whitespace
openapi.yaml: 1 line of trailing whitespace
No .github/workflows/typedoc.yml, no typedoc.json, no entry-point config, no gh-pages publish step. I think the branch you pushed doesn't contain the work — the typedoc files are likely staged in a different branch or stashed locally. Could you git status to confirm where the TypeDoc commits ended up, then git push them here?
Once the actual TypeDoc workflow + config land, this will close #62. Until then I can't merge — there's nothing wired up. Also worth reverting the two whitespace changes since they're noise.
Miracle656
left a comment
Miracle656
left a comment
There was a problem hiding this comment.
Thanks for the PR, but the diff here doesn't implement what the title/#62 describes. The only change in both files is trailing whitespace added to two lines (the CMD line in the Dockerfile and type: object in openapi.yaml) — there's no TypeDoc generation step and no gh-pages publish workflow.
To close #62 this PR needs to actually:
- add a
typedocdev-dependency + a script that generates the API reference from the TypeScript sources, and - add a GitHub Actions workflow that runs it on push to
mainand publishes the output to thegh-pagesbranch (e.g. viapeaceiris/actions-gh-pages).
Please also revert the stray trailing-whitespace edits. Happy to re-review once the actual TypeDoc publishing is in place.
…aith into ci/typedoc-publish
…ded testPathIgnorePatterns to exclude integration and chaos tests from Jest. - Updated the transform configuration for ts-jest for better readability. - Added vitest as a new dependency for testing. - Removed duplicate fast-check dependency. test: improve opa.test.ts to handle OPA requests more robustly - Changed opaRequestSpy declaration from let to var to avoid ReferenceError due to hoisting. - Enhanced the mock implementation of opaRequestSpy to correctly pass through non-OPA requests. - Updated the test for OPA unreachable scenario to ensure proper handling of supertest connections.
…eady chore: refine chaos test configuration by moving transform settings under the appropriate key
…r startup behavior
|
Friendly nudge — the TypeDoc → gh-pages auto-publish is welcome. Please rebase and address the earlier review. If you're still up for it, please rebase on the latest |
2 participants
Closes #62
Summary
Related issue
Type of change
Checklist
npx tsc --noEmitpassesnpm run buildpasses