Document delta mode with tags in the README - #3
Merged
Conversation
Add a 'Delta mode with tags' subsection explaining that a delta tag source is a moving stream keyed on the match pattern, resolves the newest matching tag by tag-creation date, and keeps only the latest tag queryable. Includes worked examples: a force-updated promotion tag, the multi-release-line pitfall where 'newest by date' flips between trains, pinning to a single line with a glob, and the snapshot + retain alternative for keeping every release. Also correct stale prose in the same section: the content tools expose git_commit / git_ref / git_ref_type (not a single git_commit_ish); delta content docs carry git.ref_pattern (not git.ref); and remove the obsolete pre-ref_key backfill paragraph (--no-backfill no longer exists).
simianhacker
marked this pull request as ready for review
August 26, 2026 00:26
davemoore-
approved these changes
Aug 26, 2026
davemoore-
left a comment
davemoore-
left a comment
Collaborator
There was a problem hiding this comment.
Good find, this was definitely worth calling out explicitly
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
2 participants
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.
What
Documents how
mode: deltabehaves for tags, and corrects stale prose in the same READMEsection.
New "Delta mode with tags" subsection explains that a delta tag source is a moving stream whose identity is the
matchpattern (not a single tag name): each run resolves the newest matching tag by tag-creation date and keeps only that latest tag queryable. Worked examples cover a force-updated promotion tag (deploy@*), the multi-release-line pitfall where "newest by date" flips between trains (Kibana9.5/9.4/8.19), pinning to one line with a glob (v9.5.*), and the snapshot +retainalternative for keeping every release.For Kibana style repos, you need to be aware when creating a matcher for tags while using delta. Do not use
v{major}.{minor}.{patch}.Also fixes three stale claims left in the section by the delta feature's later design changes:
git_commit/git_ref/git_ref_type(not a singlegit_commit_ish)git.ref_pattern(notgit.ref)ref_keybackfill" paragraph —--no-backfilland the backfillpath no longer exist in the code
How to Verify
README.md.matchpattern shown compiles undersrc/sourcerer/version.py(
deploy@*,v9.5.*,v{major}.{minor}.{patch}); the invalid placeholder-only forms(
v9.5.{patch},deploy@{build}) are intentionally avoided.grep -rn "git_commit_ish\|no-backfill\|backfill" README.md src/returns nothing.Notes
git_commit_ishwording also survives insrc/sourcerer/skills/ref-resolution/SKILL.md— out of scope here, worth a follow-up.