Skip to content

[CTX-0279] docs(website-sync): update pin-advance CLI to schema-2 form #438

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Xuepoo merged 1 commit into from
Oct 5, 2026
Merged

[CTX-0279] docs(website-sync): update pin-advance CLI to schema-2 form #438

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions docs/development/website-sync.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,9 +65,15 @@ resolves to a single SHA. The file has no extra keys and is committed.
Synchronization is the single command defined by SY-2:

```sh
bun run sync:docs --pin <40-char-sha-or-tag>
just docs-sync --source <id> --pin <sha|tag>
# equivalent: bun run sync:docs --source <id> --pin <sha|tag>
```

`<id>` is the pin entry's source id (for example `bitty-docs`).
`--pin` without `--source` is accepted only while exactly one source
is pinned; once more than one source is pinned, `--pin` requires
`--source`.

Behavior, per the RFC and `bitty-website/scripts/sync-docs.mjs`:

1. Reject a missing `--pin`, a short SHA, or a floating name such as
Expand Down Expand Up @@ -277,10 +283,14 @@ publish a docs change:
mirror:

```sh
just docs-sync PIN=<merged-docs-sha>
# equivalent: bun run sync:docs --pin <merged-docs-sha>
just docs-sync --source <id> --pin <merged-docs-sha>
# equivalent: bun run sync:docs --source <id> --pin <merged-docs-sha>
```

`<id>` is the pin entry's source id (for example `bitty-docs`).
The `PIN=<sha>` just-variable form is rejected; pass `--source`
and `--pin` as arguments.

3. Verify the mirror is current and reproducible:

```sh
Expand Down Expand Up @@ -319,8 +329,9 @@ here.
`docs/project/redirects.json` when a published identity moves, and
passes `just check`.
2. The `bitty-website` change advances the pin to that exact docs SHA
via `bun run sync:docs --pin <sha>`, implements presentation or
routing changes, and passes `just check` with the new pin.
via `just docs-sync --source <id> --pin <sha>`, implements
presentation or routing changes, and passes `just check` with the
new pin.
3. Each pull request links the other (`Docs-PR`, optional `Code-PR`,
`RFC: Website Delivery RFC OQ-023`, `CarryCtx: CTX-XXXX`) and names
ordering constraints.
Expand Down
Loading