Repository navigation
Guard doc-sourced samples: edit them in webhook-registry - #95
Merged
Merged
Conversation
Doc-sourced samples (files with a `source` key) come from webhook-registry's samples-doc through its sync workflow, on the registry-sync branch. A new check fails any other pull request that adds, changes or deletes one, so fixes land in the registry and the hub and Inspect stop drifting apart. Captures are unaffected, and a capture replacing a doc sample passes. ordinal and polytomic, whose doc samples are maintained here, are exempt. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Mp6yzxrVELJ8wYUxdn1aRi
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
- The registry-sync exemption now also requires the PR's head repo to be this repo, so a fork's registry-sync branch doesn't pass. - Replacing a doc sample with a capture (dropping the `source` key) now needs the PR labelled `capture`; otherwise an edited doc file could pass as a capture and the sync would leave it alone for good. The check re-runs on label changes. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Mp6yzxrVELJ8wYUxdn1aRi
This branch was successfully deployed
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.
Requested by Gareth · project thread
Why
Doc samples were edited both here and in webhook-registry's
samples-doc/, so the hub and Inspect drifted apart (#92 to #94). From now on they're edited in the registry only, and its new sync workflow (hookdeck/webhook-registry#194) brings them here as a rolling PR from theregistry-syncbranch.What changes
sourcekey unless the PR comes from this repo's ownregistry-syncbranch. A fork's branch with that name doesn't count. Captures are unaffected. Replacing a doc sample with a capture (dropping itssourcekey) passes only when the PR is labelledcapture, so an edited doc file can't pass as a capture. The check re-runs when labels change..github/doc-samples-guard.jsonexemptsordinalandpolytomic, whose doc samples are maintained here rather than in the registry.Merge after #94. That PR edits 360 doc samples by hand, so it would fail this check. I ran the guard locally: it fails #94's diff as expected and passes when
HEAD_REF=registry-sync.https://claude.ai/code/session_01Mp6yzxrVELJ8wYUxdn1aRi
Generated by Claude Code