Repository navigation
Regenerate the API reference when packages are published - #5
Merged
Merged
Conversation
data/api/ was regenerated by hand, so the reference fell behind every release. A new workflow handles the `packages-published` dispatch that probitas and probitas-packages send after publishing: it waits until npm reports the published versions (or newer) as latest, regenerates the data, checks the build and links, and opens a pull request from api-docs/update or updates the open one. Dispatches queue rather than replace each other, since each waits only for its own versions. It can also be run by hand. 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 Referenceworkflow (.github/workflows/update-api.yml) on thepackages-publishedrepository dispatch that probitas and probitas-packages send after publishing (and by hand): it waits until npm reports each published version, or a newer one, aslatest; runsnpm run generate-api, the build and the link check in the dev shell; and whendata/api/changed, force-pushesapi-docs/updateand opens a pull request (or updates the open one).queue: max) instead of replacing a pending one, since each waits only for its own versions; the job checks outmainso a manual run from another branch cannot carry its commits into the pull request.Why
data/api/was regenerated by hand, so the API reference fell behind every release.Stacked on #4 (base
chore/oss-init). This repository does not delete merged branches, so retarget this PR tomainafter #4 merges.Note: the local actionlint does not know
concurrency.queueyet and flags it; GitHub documents it (singledefault,maxkeeps up to 100 pending runs).Test Plan
actionlint(apart fromqueue), the version comparison checked for equal, newer and olderlatest🤖 Generated with Claude Code
https://claude.ai/code/session_01N3xvJ1TaozjYSE6eoyo9mq