docs: expand the catalog versioning guide#116
Merged
Conversation
The catalog-versioning guide covered `fce catalog diff` but said nothing about how `fce catalog update` behaves when the existing baseline is imperfect. Document the resilience contract that ships with the commands: a corrupt or unreadable baseline is regenerated with a warning, while a baseline written by a newer schema is refused (upgrade the tool) rather than silently downgraded. Add the cancellation exit code (130) to the `catalog diff` table and spell out `catalog update`'s exit codes, in both the English and French guides. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01J12ghrzM1xiAKw4LETJDqr
Each base example showed only the bare `fce` command, leaving the reader to guess who runs it and when. Keep the plain command as the minimal illustration, then add a near-copy-paste CI/CD block beside it: seed the baseline automatically on first run (create + commit only when missing), and accept an intentional contract change from CI via a labelled pull request that regenerates and commits the baseline onto its branch. Added to both the English and French guides, with the same commands. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01J12ghrzM1xiAKw4LETJDqr
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.
Summary
Follow-up to the catalog-versioning feature (PR #110): the guide documented
fce catalog diffbut not howfce catalog updatebehaves when the baseline is imperfect, and every step showed only the barefcecommand with no hint of who runs it in a pipeline. This fills both gaps — documentation only, no code change.Type of change
Changes
130(cancellation) to thecatalog difftable and spelled outcatalog update's exit codes.fcecommand as the minimal illustration — for seeding the baseline on first run (create + commit only when missing) and accepting an intentional contract change from CI via a labelled pull request.doc/CatalogVersioning.en.mdanddoc/CatalogVersioning.fr.md(kept in sync).Testing
Documentation only — no code changed, so the build and test suites are unaffected and none of the boxes below were run. Verified instead: English/French structural parity (identical headings, fenced code blocks and length) and that every relative link resolves.
dotnet build FirstClassErrors.slndotnet test FirstClassErrors.slnFirstClassErrors.Analyzers.UnitTests)Documentation
doc/updateddoc/README.fr.md) updated if user-facing behavior changedRelated issues
None — documentation follow-up to PR #110 (merged).