ci: changelog breaking-change workflow, version-bump docs, and keywords#51
Merged
Conversation
The CLI is versioned independently from sql-insight, and neither release-plz nor cargo-semver-checks can detect output/behavioural changes (they see the API surface only). Document the manual rule in sql-insight-cli/Cargo.toml: bump the CLI minor when its output *format* changes (own code or adopting a breaking sql-insight the caret requirement won't accept); a value-only change is a patch, and compatible sql-insight bumps flow via the caret without a CLI release. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Surface the normalizer / query-fingerprinting feature in crate discovery. keywords cap at 5, so drop the weakest from each: "query" (overlaps "sql") on sql-insight, "analysis" (generic) on sql-insight-cli. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
✅ PR title follows the Conventional Commits spec. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #51 +/- ##
=======================================
Coverage 94.87% 94.87%
=======================================
Files 27 27
Lines 5486 5486
Branches 5486 5486
=======================================
Hits 5205 5205
Misses 203 203
Partials 78 78 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
A breaking change now renders as a `####` heading plus an optional free-form block — the text the author wraps between `**▼ changelog ▼**` / `**▲ changelog ▲**` markers in the PR description, sliced from `commit.raw_message` (not `commit.body`, whose footer parsing would eat a `**label:**` line). The block may span paragraphs and code fences and carry `**sql-insight:**` / `**sql-insight-cli:**` labels for a PR that breaks both crates; the same range lands in both changelogs, since the per-crate changelog template cannot route content per crate. Add .github/pull_request_template.md (the block is commented out by default; uncomment it for a breaking change) and document the convention in CLAUDE.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
takaebato
changed the title
Open
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.
Repository / release tooling and docs — no library or CLI behaviour change.
Changelog (breaking-change workflow)
####heading plus an optional free-form block, sliced from the PR description between`**▼ changelog ▼**`/`**▲ changelog ▲**`markers (read fromcommit.raw_message, so a**label:**line isn't parsed away as a commit footer). The block may span paragraphs and code fences and carry**sql-insight:**/**sql-insight-cli:**labels for a cross-cutting PR — the same range lands in both crates' changelogs, since the per-crate changelog template can't route content per crate..github/pull_request_template.md(the marker block is commented out by default; uncomment it for a breaking change) and document the convention inCLAUDE.md.Versioning
sql-insight-cli/Cargo.tomlwhen to bump the CLI version by hand: an output-format change is a minor (pre-1.0 breaking), a value-only change is a patch. This is manual because neither release-plz nor cargo-semver-checks detects output/behavioural changes (they see the API surface only), and a dependency-only bump cascades just a patch.Metadata
normalizationkeyword to both crates so the normalizer / query-fingerprinting feature surfaces in crate discovery (the keyword cap is 5, so the weakest existing keyword is dropped from each).🤖 Generated with Claude Code