Repository navigation
#108: Write down the ecosystem's release, versioning and cross-repository rules - #109
Merged
Merged
Conversation
…tory rules CONTRIBUTING.md gains three sections and two PR rules, each stated once and linking the page that holds its details: - § Releasing the ecosystem: the release order (utilities, component release PRs, the go/no-go, tags, the pin PR, this repository's tag with the compatibility table, the milestone run) and the version rules - § Changes across repositories: one issue per repository, a Pointer issue here, a "Cross-repo change - N of M" block in each PR - § Ecosystem conventions: living-doc-generator-markdown is the reference repository; its action.yml venv step is the template - § PR Description: name the canon rules a PR implements; a Copilot review before the owner's; criteria checked against code, not tests - Purpose, Contents and the level-D row name them; CONTEXT.md points to them
Closed
7 tasks
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.
Overview
CONTRIBUTING.mdnow states the ecosystem's development rules that no page held: the release order, the version rules, changes across repositories, the repository conventions with the composite-action template, and the canon and review rules of a PR. Each is stated once, and links the page that holds its details.Per criterion:
docs/_integration/README.md§ Release go/no-go and § Run a milestone target, each component'sDEVELOPER.md§ Release, and thev0.1.0release notes as the model of the compatibility table. The version rules linkliving-doc-utilitiesdocs/api.md§ Versioning for pinning and bumping.living-doc-generator-markdown'saction.ymlandDEVELOPER.md§ Action venv. The template states only whataction.ymldoes atv0.1.0(005a058, today'smaster).## Purpose,## Contentsand the level table's D row name the new sections; rootCONTEXT.md§ Conventions points to them.AGENTS.md§ Check passes locally: pytest overtests/examples,tests/docsandtests/integration(354 passed);examples_check.py;retired_names_check.py --strictat the pins; the agentic scripts andagentskills validate;sync-canon-copies.sh allandregen-collector-snapshots.shwith no change;run-testbed-stage.sh; lychee over every tracked page (0 errors).Three points go past the issue's wording, each from a source it names:
living-doc-utilities(step 1 of its § Release). The tag is cut at the commit the go/no-go ran, so the bump comes first; forv0.1.0each component's "Prepare the release" PR did both.living-doc-utilities§ Versioning does.living-doc-utilitiesand the components only: this repository has noMakefile, and its tutorial workflow calls actions by tag.Follow-ups: component pages that contradict the version rules
living-doc-collector-ghDEVELOPER.md§ Versioning: "MAJOR: a breaking change to a schema or API contract" and "MINOR: a new feature or a non-breaking enhancement". Under0.xa minor may break, and a contract change is aliving-doc-utilitiesminor. Its § Release example tag,v1.0.1, is a1.xtag.living-doc-toolkitSPEC.md§ 4 Cross-cutting contract changes: "additive (no bump), or breaking (major bump of the affected package)". Under0.xa breaking change is a minor.living-doc-toolkit.github/copilot-review-rules.md: "breaking (major bump of the affected package)", citing the same section.Checked, no contradiction:
living-doc-utilitiesdocs/api.md§ Versioning;living-doc-toolkitandliving-doc-generator-markdownDEVELOPER.md§ Versioning.living-doc-collector-adandliving-doc-generator-pdfstate no package version rule.Canon rules relied on
docs/introduction/principles.md§ The frame, F5:living-doc-utilitiesholds the contract models, so a contract change is its release, and the consumers re-pin.living-doc-utilitiesinstead of copying it.CONTRIBUTING.md§ Writing documentation: level D, flow rule 3 (a reference fact is linked, never restated), and the page anatomy.docs/CONTEXT.md§ Conventions: a link to a component page points atmaster.No disagreement with the canon came up.
Release Notes
CONTRIBUTING.md§ Releasing the ecosystem states the release order across the repositories and the version rules.CONTRIBUTING.md§ Changes across repositories: one issue per repository, a Pointer issue here, and a "Cross-repo change — N of M" block in each PR.CONTRIBUTING.md§ Ecosystem conventions:living-doc-generator-markdownis the reference repository, and its venv step is the composite-action template.CONTRIBUTING.md§ PR Description: a PR names the canon rules it implements, and gets a Copilot review before the owner's.Framework
docs/introduction/principles.mdin this PRContributor documentation only: no part's responsibility changes. The version rules rest on F5 and F7.
Related
Closes #108