Repository navigation
Make the post-publish docs-bump PR cover schema assets and @basou/sdk - #48
Merged
Merged
Conversation
The docs-bump job regenerates basou-site with `pnpm gen:docs`, which writes two roots: the version-coupled mdx under src/content/docs and the verbatim JSON Schema artifacts under public/schemas (served at basou.dev/schemas/). The create-pull-request add-paths allowlist only listed src/content/docs, so on a release that changes a schema the regenerated schema files were dropped from the PR while the mdx that references them was included. basou-site's gen:docs:check then failed the build on the drifted, unstaged schemas (observed on the v0.7.0 bump PR). Add public/schemas to all three places the allowlist is expressed: the create-pull-request add-paths, the change-detection diff, and the outside-allowlist warning exclude, so schema-changing releases stage the regenerated artifacts. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The docs-bump job pinned @basou/core and @basou/cli to the released version but left @basou/sdk untouched, so basou-site's gen:docs read the SDK package version from a stale @basou/sdk and the generated sdk.mdx (and basou.dev/sdk/) reported a version one release behind. The SDK read-API version is separate (BASOU_SDK_VERSION) and is unaffected. Add @basou/sdk to the pinned bump so the package version shown in the SDK docs tracks the release, and update the progress messages, PR title/body, and step name to match. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
4 of 6 tasks
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.
Summary
Two fixes to the
update-docs-sitejob in the release pipeline so theauto-generated basou-site docs-bump PR fully reflects a release. CI-only;
no product code changes.
Why
On a
vX.Y.Ztag push this job opens a PR on basou-site that pins thefreshly published
@basoupackages and regenerates docs withpnpm gen:docs. Two completeness gaps surfaced on the v0.7.0 release:Schema assets were dropped.
pnpm gen:docswrites two roots: theversion-coupled mdx under
src/content/docs/**and the verbatim JSONSchemas served at
basou.dev/schemas/underpublic/schemas/**. Thecreate-pull-request
add-pathsallowlist only listedsrc/content/docs,so on a schema-changing release the regenerated schema files were left
unstaged while the mdx that references them was included. basou-site's
gen:docs:checkthen failed the build on the drift (the v0.7.0 bump PRhad to be patched by hand). Fixed by adding
public/schemasto all threeplaces the allowlist is expressed: the
add-paths, the change-detectiondiff, and the outside-allowlist warning exclude.
@basou/sdkwas not bumped. The pin covered@basou/coreand@basou/clibut not@basou/sdk, so basou-site'ssdk.mdx(andbasou.dev/sdk/) reported a stale SDK package version one releasebehind. The SDK read-API version (
BASOU_SDK_VERSION) is trackedseparately and is unaffected. Fixed by adding
@basou/sdkto the pinnedbump and updating the progress messages, PR title/body, and step name.
Checklist
main(branched from currentmainHEAD).update-docs-sitejob runs only ona real tag-push publish (its steps are gated to
github.event_name == 'push'), so it cannot be exercised by CI or aworkflow_dispatchdry-run. The next release is the live test. Verified statically with
actionlint(no new findings vsmain) and git-pathspec checks.pnpm lint/pnpm typecheck/pnpm testunaffected (CI-onlychange); quality.yml still passes.
CHANGELOG.md— N/A. Internal release-infra, consistent with priorci(release):commits that carried no changelog entry.Related
basou-site#9 for this release.