Repository navigation
Ask the docs site to regenerate its API reference after a release - #125
Merged
Merged
Conversation
The documentation site's API reference is generated from the npm packages, but nothing told it a release had happened, so the reference stayed behind until someone regenerated it by hand. After publishing, the release now dispatches `packages-published` to probitas-test.github.io with the versions it published, the way it already asks the Homebrew tap to update; the site regenerates and opens a pull request. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01N3xvJ1TaozjYSE6eoyo9mq
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.
Summary
update-api-docsjob calls.github/workflows/update-api-docs.yml, which dispatchespackages-publishedto probitas-test.github.io with{"packages": {"@probitas-test/probitas": "<version>"}}, usingREPOSITORY_DISPATCH_TOKENlike the Homebrew update does. The workflow can also be run by hand.Why
The documentation site's API reference is generated from the npm packages, but nothing told it a release had happened, so it stayed behind until regenerated by hand. The site side (probitas-test/probitas-test.github.io) waits for the version to reach npm, regenerates, and opens a pull request.
Stacked on #124 (base
chore/oss-init); it retargets tomainwhen #124 merges and its branch is deleted.Test Plan
actionlint{}and check the site opens or updates its pull request🤖 Generated with Claude Code
https://claude.ai/code/session_01N3xvJ1TaozjYSE6eoyo9mq