aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(standards): MR-based tag strategy + repository inventory (registry://repos)

Browse Source 
Versioning standard now documents the MR flow: bump pyproject.toml/VERSION and promote CHANGELOG in the MR (referencing the version/tag, not a commit id), merge/squash, then tag the resulting commit. Adds the agent-assisted tagging procedure (wait for the go-ahead, find the version-bump commit, tag only it, ask the user to push) to both the reference page and the releasing wiki runbook. Adds the repo inventory (src/repos.json -> mcp/repos.json), the registry://repos resource + list_repos tool, the 15_repository_inventory lib page, and two MCP prompts: compliance (remediate repos) and release (agent tagging).
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-10-15 14:39:21 +05:30
parent df03f41771
commit 5971f26c08
36 changed files with 2107 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
build.py
View File

@@ -490,6 +490,39 @@ def build_release_templates(folder: Path, dry_run: bool = False) -> None:
f"({len(manifest['components'])} components)") f"({len(manifest['components'])} components)")
# ── Repository inventory bundle ───────────────────────────────────────────────
def build_repos(folder: Path, dry_run: bool = False) -> None:
"""Publish ``folder/src/repos.json`` as ``<name>/mcp/repos.json``.
The repository inventory (name, type, version source, Drone shape) is a
single hand-authored JSON file, surfaced to agents through the
``registry://repos`` resource and the ``list_repos`` tool. See standards
"15_repository_inventory".
Args:
folder (Path): The hub folder owning ``src/repos.json``.
dry_run (bool): Print the plan without executing.
"""
name = folder.name
src = folder / "src" / "repos.json"
if not src.is_file():
return
out = folder / "mcp" / "repos.json"
if dry_run:
print(f"[REP] {name} {src.relative_to(ROOT)} -> {out.relative_to(ROOT)}")
return
data = json.loads(src.read_text(encoding="utf-8"))
out.parent.mkdir(parents=True, exist_ok=True)
out.write_text(
json.dumps(data, indent=2, ensure_ascii=False), encoding="utf-8"
)
print(f"[REP] {name} repo inventory written to {out.relative_to(ROOT)} "
f"({len(data.get('repos', []))} repos)")
# ── CLI ────────────────────────────────────────────────────────────────────── # ── CLI ──────────────────────────────────────────────────────────────────────
@@ -511,6 +544,7 @@ def main() -> None:
build_templates(folder, dry_run=args.dry_run) build_templates(folder, dry_run=args.dry_run)
build_drone_templates(folder, dry_run=args.dry_run) build_drone_templates(folder, dry_run=args.dry_run)
build_release_templates(folder, dry_run=args.dry_run) build_release_templates(folder, dry_run=args.dry_run)
build_repos(folder, dry_run=args.dry_run)
build_html(folder, dry_run=args.dry_run) build_html(folder, dry_run=args.dry_run)

108
registry.py
View File

@@ -12,6 +12,7 @@ Resources:
registry://components (the template component index) registry://components (the template component index)
registry://drone (the CI template index) registry://drone (the CI template index)
registry://release (the release template index) registry://release (the release template index)
registry://repos (the repository inventory)
Tools: Tools:
ping (from the base server) ping (from the base server)
@@ -23,12 +24,15 @@ Tools:
get_drone_template (kind -> exact .drone.yml template) get_drone_template (kind -> exact .drone.yml template)
list_release_templates (the changelog + version-file artefacts) list_release_templates (the changelog + version-file artefacts)
get_release_template (kind -> exact release template file) get_release_template (kind -> exact release template file)
list_repos (the covered repositories: type, path, version source)
Prompts: Prompts:
intake (the questions to gather before building) intake (the questions to gather before building)
build (the two axes -> deterministic build prompt) build (the two axes -> deterministic build prompt)
start_app (combined entry: intake, then build) start_app (combined entry: intake, then build)
trial (self-contained trial build into a scratch dir) trial (self-contained trial build into a scratch dir)
compliance (remediate repos against the CI + versioning standard)
release (agent-assisted tagging after the release MR is merged)
""" """
from __future__ import annotations from __future__ import annotations
@@ -94,6 +98,45 @@ def _build_text(app_name: str, resources: str, pipelines: str, auth: str) -> str
) )
_COMPLIANCE_TEXT = (
"# Compliance — align repositories with the CI + versioning standard\n\n"
"Read `docs://modules/drone_pipelines` and `docs://modules/versioning_and_changelog`,\n"
"then enumerate the working set with `registry://repos` (or `list_repos()`).\n\n"
"For each repository, bring it to the standard for its `type`:\n\n"
"- **package** — `version` in `pyproject.toml`; root `CHANGELOG.md`; Drone file\n"
" from `get_drone_template(\"drone-pypi\")` (`python-lib.yaml`, tag-triggered).\n"
"- **service / site** — root `VERSION`; root `CHANGELOG.md`; Drone file from\n"
" `get_drone_template(\"drone-service\")` (`service-docker.yaml`; tag-triggered\n"
" service variant, push-triggered site variant).\n\n"
"Steps:\n"
"1. Inspect each repo (`git -C <path> tag`, version file, `CHANGELOG.md`,\n"
" `.drone.yml`) and list the gaps — never assume.\n"
"2. Add missing files from `get_release_template(\"changelog\"/\"version-file\")`.\n"
"3. Replace `.drone.yml` with the guarded template for the repo's type.\n"
"4. Align the version file with the intended tag.\n"
"5. Commit per repo (one focused commit); **do not push or tag** without the\n"
" user's explicit go-ahead.\n"
)
_RELEASE_TEXT = (
"# Release — tag the merged commit\n\n"
"The version bump and changelog promotion live **in the release merge\n"
"request**; the tag is created on the commit that results from merging it.\n"
"See `docs://modules/versioning_and_changelog`.\n\n"
"Do this only after the user confirms the MR is merged/squashed and tells you\n"
"to proceed — never tag before the merge.\n\n"
"1. Wait for that explicit go-ahead.\n"
"2. Find the commit that introduced the version bump `x.y.z`:\n"
" - package: `git log -S 'version = \"x.y.z\"' -n 1 --format='%H %s' -- pyproject.toml`\n"
" - service / site: `git log -S 'x.y.z' -n 1 --format='%H %s' -- VERSION`\n"
"3. Verify that commit's version file equals `x.y.z` (the Drone guard enforces\n"
" `tag == version`).\n"
"4. Tag **only** that commit, lightweight and bare: `git tag x.y.z <sha>`.\n"
"5. **Do not push.** Ask the user to run `git push origin x.y.z`, then Drone\n"
" builds the release.\n"
)
class StandardsMCPServer(MCPServer): class StandardsMCPServer(MCPServer):
"""MCP server for the `standards` bundle with discovery/scaffolding tools. """MCP server for the `standards` bundle with discovery/scaffolding tools.
@@ -146,6 +189,13 @@ class StandardsMCPServer(MCPServer):
return {"error": "not_found", "path": str(path), "components": []} return {"error": "not_found", "path": str(path), "components": []}
return json.loads(path.read_bytes()) return json.loads(path.read_bytes())
def _repos(self) -> dict[str, Any]:
"""Load the repository inventory."""
path = Path(self.mcp_root) / "repos.json"
if not path.exists():
return {"error": "not_found", "path": str(path), "repos": []}
return json.loads(path.read_bytes())
def _find_release_component(self, kind: str) -> dict[str, Any] | None: def _find_release_component(self, kind: str) -> dict[str, Any] | None:
for entry in self._release().get("components", []): for entry in self._release().get("components", []):
if entry.get("kind") == kind: if entry.get("kind") == kind:
@@ -258,9 +308,19 @@ class StandardsMCPServer(MCPServer):
return self._drone() return self._drone()
@self.app.resource("registry://release") @self.app.resource("registry://release")
def release() -> dict[str, Any]: def release_templates() -> dict[str, Any]:
return self._release() return self._release()
@self.app.resource("registry://repos")
def repos() -> dict[str, Any]:
"""Return the repository inventory.
Use this to enumerate the repositories covered by the CI and
versioning standards, each with its type, path, version source, and
Drone shape. Paths are relative to the aetos/ workspace root.
"""
return self._repos()
@self.app.resource("docs://spec") @self.app.resource("docs://spec")
def spec() -> dict[str, Any]: def spec() -> dict[str, Any]:
"""Return the pinned auth-server OpenAPI contract. """Return the pinned auth-server OpenAPI contract.
@@ -452,6 +512,27 @@ class StandardsMCPServer(MCPServer):
} }
return self._read_release_component(entry) return self._read_release_component(entry)
@self.app.tool()
def list_repos(type: str | None = None) -> list[dict[str, Any]]:
"""List the repositories covered by the CI and versioning standards.
Each entry has: ``name``, ``type`` ("package" | "service" | "site"),
``path`` (relative to the aetos/ workspace root), ``version_source``
("pyproject.toml" | "VERSION"), ``drone`` (the template file),
``trigger`` ("tag" | "push"), ``docs`` kinds, and ``mcp``.
Args:
type (str | None): Optional filter, e.g. "package" or "site".
Returns:
list[dict[str, Any]]: Matching repository entries.
"""
repos = self._repos().get("repos", [])
if type:
needle = type.strip().lower()
return [r for r in repos if str(r.get("type", "")).lower() == needle]
return repos
@self.app.prompt() @self.app.prompt()
def intake() -> str: def intake() -> str:
"""Return the questions to gather before building an app. """Return the questions to gather before building an app.
@@ -544,3 +625,28 @@ class StandardsMCPServer(MCPServer):
"back so the standard can be amended.\n\n" "back so the standard can be amended.\n\n"
f"Delete `{target}` once you are satisfied.\n" f"Delete `{target}` once you are satisfied.\n"
) )
@self.app.prompt()
def compliance() -> str:
"""Return the procedure to align repositories with the standard.
Use this to audit and remediate the repos listed in
`registry://repos` against the Drone and versioning standards.
Returns:
str: The compliance/remediation prompt.
"""
return _COMPLIANCE_TEXT
@self.app.prompt()
def release() -> str:
"""Return the agent-assisted tagging procedure.
Use after the user confirms the release MR is merged/squashed: find
the commit that bumped the version file, tag only that commit, and
ask the user to push the tag.
Returns:
str: The release/tagging prompt.
"""
return _RELEASE_TEXT

22
standards/lib/01_build_recipe/index.html
View File

@@ -593,6 +593,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

22
standards/lib/02_layering_rules/index.html
View File

@@ -584,6 +584,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

22
standards/lib/03_composition_root/index.html
View File

@@ -575,6 +575,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

22
standards/lib/04_spec_first_routing/index.html
View File

@@ -602,6 +602,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

22
standards/lib/05_crud_template/index.html
View File

@@ -611,6 +611,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

22
standards/lib/06_pipeline_scaffold/index.html
View File

@@ -602,6 +602,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

22
standards/lib/07_worker_and_progress/index.html
View File

@@ -575,6 +575,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

22
standards/lib/08_human_in_loop/index.html
View File

@@ -584,6 +584,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

22
standards/lib/09_infra_adaptors/index.html
View File

@@ -602,6 +602,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

22
standards/lib/10_drone_pipelines/index.html
View File

@@ -575,6 +575,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

130
standards/lib/11_versioning_and_changelog/index.html
View File

@@ -14,7 +14,7 @@
<link rel="prev" href="../10_drone_pipelines/"> <link rel="prev" href="../10_drone_pipelines/">
<link rel="next" href="../12_genericity_matrix/"> <link rel="next" href="../15_repository_inventory/">
<link rel="icon" href="../assets/images/favicon.png"> <link rel="icon" href="../assets/images/favicon.png">
@@ -556,6 +556,30 @@
</span> </span>
</a> </a>
</li>
<li class="md-nav__item">
<a href="#tagging-strategy-mr-based" class="md-nav__link">
<span class="md-ellipsis">
Tagging strategy (MR-based)
</span>
</a>
<nav class="md-nav" aria-label="Tagging strategy (MR-based)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#agent-assisted-tagging" class="md-nav__link">
<span class="md-ellipsis">
Agent-assisted tagging
</span>
</a>
</li>
</ul>
</nav>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@@ -599,6 +623,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">
@@ -725,6 +771,30 @@
</span> </span>
</a> </a>
</li>
<li class="md-nav__item">
<a href="#tagging-strategy-mr-based" class="md-nav__link">
<span class="md-ellipsis">
Tagging strategy (MR-based)
</span>
</a>
<nav class="md-nav" aria-label="Tagging strategy (MR-based)">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#agent-assisted-tagging" class="md-nav__link">
<span class="md-ellipsis">
Agent-assisted tagging
</span>
</a>
</li>
</ul>
</nav>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@@ -809,8 +879,9 @@ and tag contract is exactly what those two CI shapes consume.</p>
<li><strong>Tag = version.</strong> The git tag is bare SemVer (<code>0.0.6</code>), no <code>v</code> prefix, and <li><strong>Tag = version.</strong> The git tag is bare SemVer (<code>0.0.6</code>), no <code>v</code> prefix, and
it MUST match the version file byte-for-byte. The Drone guard fails the it MUST match the version file byte-for-byte. The Drone guard fails the
build otherwise — this is what stops a tag from silently publishing nothing.</li> build otherwise — this is what stops a tag from silently publishing nothing.</li>
<li><strong>A release is a tag.</strong> Bump the version file, promote the changelog, commit, <li><strong>A release is a tag, created after the change is merged.</strong> The version bump
tag, push. Everything else is automated by Drone.</li> and the changelog promotion travel inside the merge request (MR); the tag is
added on the merged commit and pushed. See <a href="#tagging-strategy-mr-based">Tagging strategy</a>.</li>
<li><strong>Never reuse a tag.</strong> If a release is wrong, cut a new patch version.</li> <li><strong>Never reuse a tag.</strong> If a release is wrong, cut a new patch version.</li>
</ol> </ol>
<h3 id="pre-10-0yz">Pre-1.0 (0.y.z)</h3> <h3 id="pre-10-0yz">Pre-1.0 (0.y.z)</h3>
@@ -867,17 +938,50 @@ one open <code>[Unreleased]</code> section with the change categories that apply
version heading and clear it.</li> version heading and clear it.</li>
</ul> </ul>
<hr /> <hr />
<h2 id="tagging-strategy-mr-based">Tagging strategy (MR-based)</h2>
<p>The release version is known while the change is still a merge request, so the
bump travels with the change and only the tag is added afterwards:</p>
<ol>
<li><strong>In the MR</strong> — set the intended release version: <code>version</code> in
<code>pyproject.toml</code> (or the <code>VERSION</code> file) to <code>x.y.z</code>, and promote the
changelog (below). Changelog entries and link references name the
<strong>version/tag</strong>, never a commit id.</li>
<li><strong>Merge or squash</strong> the MR into <code>main</code>.</li>
<li><strong>Create the tag</strong> <code>x.y.z</code> on the resulting commit (the merge/squash commit).</li>
<li><strong>Push the tag</strong> (<code>git push origin x.y.z</code>) — Drone builds the release.</li>
</ol>
<p>Because the version bump is inside the tagged commit, the guard's
<code>tag == version</code> check can only fail if the wrong commit was tagged.</p>
<h3 id="agent-assisted-tagging">Agent-assisted tagging</h3>
<p>The agent neither authors nor merges the MR, and never tags before the merge.
After the user confirms the MR is merged/squashed and says to proceed:</p>
<ol>
<li><strong>Wait</strong> for that explicit go-ahead.</li>
<li>Find the commit that introduced the version bump:</li>
<li>packages:
<code>git log -S 'version = "x.y.z"' -n 1 --format='%H %s' -- pyproject.toml</code></li>
<li>services:
<code>git log -S 'x.y.z' -n 1 --format='%H %s' -- VERSION</code></li>
<li>Confirm that commit's version file equals <code>x.y.z</code>, then tag <strong>only</strong> that
commit, lightweight and bare: <code>git tag x.y.z &lt;sha&gt;</code>.</li>
<li><strong>Do not push.</strong> Ask the user to push the tag: <code>git push origin x.y.z</code>.</li>
</ol>
<hr />
<h2 id="release-checklist">Release checklist</h2> <h2 id="release-checklist">Release checklist</h2>
<ol> <ol>
<li>Confirm the quality gate is green on <code>main</code>.</li> <li>Confirm the quality gate is green and <code>main</code> is up to date.</li>
<li>Move every <code>[Unreleased]</code> entry under the new version heading with today's <li>In the MR: move every <code>[Unreleased]</code> entry under the new version heading with
date (<code>## [x.y.z] - YYYY-MM-DD</code>); restore an empty <code>[Unreleased]</code> on top.</li> the target date (<code>## [x.y.z] - YYYY-MM-DD</code>); restore an empty <code>[Unreleased]</code>
<li>Add the two compare-link references at the bottom of the changelog.</li> on top.</li>
<li>Set the version file: <code>pyproject.toml</code> (<code>version = "x.y.z"</code>) or <code>VERSION</code>.</li> <li>In the MR: add the two compare-link references at the bottom of the
<li>Commit: <code>chore(release): x.y.z</code>.</li> changelog, naming the version/tag (never a commit id).</li>
<li>Tag: <code>git tag x.y.z</code> and push the tag (<code>git push origin x.y.z</code>).</li> <li>In the MR: set the version file — <code>pyproject.toml</code> (<code>version = "x.y.z"</code>) or
<li>Watch Drone: Type A publishes the wheel/sdist, Type B builds and deploys the <code>VERSION</code> — to the intended release version.</li>
image. Both first assert <code>tag == version</code>.</li> <li>Merge or squash the MR into <code>main</code>.</li>
<li>Create the tag on the resulting commit: lightweight <code>git tag x.y.z</code>.</li>
<li>Push the tag (<code>git push origin x.y.z</code>). Watch Drone: Type A publishes the
wheel/sdist, Type B builds and deploys the image; both first assert
<code>tag == version</code>.</li>
<li>Do not reuse the tag if the run fails — fix and cut <code>x.y.(z+1)</code>.</li> <li>Do not reuse the tag if the run fails — fix and cut <code>x.y.(z+1)</code>.</li>
</ol> </ol>
<hr /> <hr />
@@ -891,7 +995,7 @@ Drone guard turns that silent no-op into a hard failure.</p>
<hr /> <hr />
<h2 id="related">Related</h2> <h2 id="related">Related</h2>
<ul> <ul>
<li><a href="../10_drone_pipelines/">10 – Drone Pipelines</a> · <a href="../01_build_recipe/">01 – Build Recipe</a> · <a href="../13_library_registry/">13 – Library Registry</a></li> <li><a href="../10_drone_pipelines/">10 – Drone Pipelines</a> · <a href="../15_repository_inventory/">15 – Repository Inventory</a> · <a href="../01_build_recipe/">01 – Build Recipe</a> · <a href="../13_library_registry/">13 – Library Registry</a></li>
</ul> </ul>

24
standards/lib/12_genericity_matrix/index.html
View File

@@ -11,7 +11,7 @@
<link rel="prev" href="../11_versioning_and_changelog/"> <link rel="prev" href="../15_repository_inventory/">
<link rel="next" href="../14_auth_integration/"> <link rel="next" href="../14_auth_integration/">
@@ -486,6 +486,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>

22
standards/lib/13_library_registry/index.html
View File

@@ -486,6 +486,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

22
standards/lib/14_auth_integration/index.html
View File

@@ -488,6 +488,28 @@
<li class="md-nav__item">
<a href="../15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link"> <a href="../12_genericity_matrix/" class="md-nav__link">

983
standards/lib/15_repository_inventory/index.html Normal file
View File

@@ -0,0 +1,983 @@
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="The rules and library registry of the standardized application blueprint.">
<link rel="prev" href="../11_versioning_and_changelog/">
<link rel="next" href="../12_genericity_matrix/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>Repository Inventory - Aetos Standards — Reference</title>
<link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#repository-inventory" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Aetos Standards — Reference" class="md-header__button md-logo" aria-label="Aetos Standards — Reference" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Aetos Standards — Reference
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Repository Inventory
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="cyan" aria-hidden="true" type="radio" name="__palette" id="__palette_0">
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Aetos Standards — Reference" class="md-nav__button md-logo" aria-label="Aetos Standards — Reference" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
Aetos Standards — Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../01_build_recipe/" class="md-nav__link">
<span class="md-ellipsis">
Build Recipe
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../02_layering_rules/" class="md-nav__link">
<span class="md-ellipsis">
Layering Rules
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../03_composition_root/" class="md-nav__link">
<span class="md-ellipsis">
Composition Root
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../04_spec_first_routing/" class="md-nav__link">
<span class="md-ellipsis">
Spec-First Routing
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../05_crud_template/" class="md-nav__link">
<span class="md-ellipsis">
CRUD Template
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../06_pipeline_scaffold/" class="md-nav__link">
<span class="md-ellipsis">
Pipeline Scaffold
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../07_worker_and_progress/" class="md-nav__link">
<span class="md-ellipsis">
Worker & Progress
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../08_human_in_loop/" class="md-nav__link">
<span class="md-ellipsis">
Human-in-the-Loop
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../09_infra_adaptors/" class="md-nav__link">
<span class="md-ellipsis">
Infra Adapters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../10_drone_pipelines/" class="md-nav__link">
<span class="md-ellipsis">
Drone Pipelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../11_versioning_and_changelog/" class="md-nav__link">
<span class="md-ellipsis">
Versioning & Changelog
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Repository Inventory
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#packages-type-a" class="md-nav__link">
<span class="md-ellipsis">
Packages (Type A)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#services-sites-type-b" class="md-nav__link">
<span class="md-ellipsis">
Services &amp; sites (Type B)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#required-files-per-repo" class="md-nav__link">
<span class="md-ellipsis">
Required files per repo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reading-this-at-runtime" class="md-nav__link">
<span class="md-ellipsis">
Reading this at runtime
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#related" class="md-nav__link">
<span class="md-ellipsis">
Related
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../12_genericity_matrix/" class="md-nav__link">
<span class="md-ellipsis">
Genericity Matrix
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../14_auth_integration/" class="md-nav__link">
<span class="md-ellipsis">
Auth Integration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../13_library_registry/" class="md-nav__link">
<span class="md-ellipsis">
Library Registry
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#packages-type-a" class="md-nav__link">
<span class="md-ellipsis">
Packages (Type A)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#services-sites-type-b" class="md-nav__link">
<span class="md-ellipsis">
Services &amp; sites (Type B)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#required-files-per-repo" class="md-nav__link">
<span class="md-ellipsis">
Required files per repo
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#reading-this-at-runtime" class="md-nav__link">
<span class="md-ellipsis">
Reading this at runtime
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#related" class="md-nav__link">
<span class="md-ellipsis">
Related
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="repository-inventory">Repository Inventory</h1>
<h2 id="summary">Summary</h2>
<p>The canonical list of Aetos repositories covered by the CI and versioning
standards, with the artifact each one produces, its version source, and its
Drone shape. Every entry maps to the contract in
<a href="../11_versioning_and_changelog/">11 – Versioning &amp; Changelog</a> and the two CI
files in <a href="../10_drone_pipelines/">10 – Drone Pipelines</a>.</p>
<p>The same data is published machine-readably as the <code>registry://repos</code> MCP
resource (and the <code>list_repos</code> tool), sourced from <code>standards/src/repos.json</code>.
Paths are relative to the <code>aetos/</code> workspace root.</p>
<hr />
<h2 id="packages-type-a">Packages (Type A)</h2>
<p>A wheel + sdist published to the private index. Version source is
<code>pyproject.toml</code>; Drone file is <code>python-lib.yaml</code> (tag-triggered).</p>
<table>
<thead>
<tr>
<th>Repo</th>
<th>Path</th>
<th>Docs</th>
<th>MCP server</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>dagpipe</code></td>
<td><code>dagpipe</code></td>
<td>lib, wiki</td>
<td><code>dagpipe:8006</code></td>
</tr>
<tr>
<td><code>doc-forge</code></td>
<td><code>doc-forge</code></td>
<td>lib, wiki</td>
<td><code>docforge:8001</code></td>
</tr>
<tr>
<td><code>hexa</code></td>
<td><code>hexa</code></td>
<td>lib, wiki</td>
<td><code>hexa:8008</code></td>
</tr>
<tr>
<td><code>mail-intake</code></td>
<td><code>mail-intake</code></td>
<td>lib, wiki</td>
<td><code>mail_intake:8002</code></td>
</tr>
<tr>
<td><code>mongo-ops</code></td>
<td><code>mongo-ops</code></td>
<td>lib, wiki</td>
<td><code>mongo_ops:8007</code></td>
</tr>
<tr>
<td><code>omniread</code></td>
<td><code>omniread</code></td>
<td>lib, wiki</td>
<td><code>omniread:8003</code></td>
</tr>
<tr>
<td><code>openapi-first</code></td>
<td><code>openapi-first</code></td>
<td>lib, wiki</td>
<td><code>openapi_first:8004</code></td>
</tr>
<tr>
<td><code>py-jwt</code></td>
<td><code>py-jwt</code></td>
<td>lib, wiki</td>
<td><code>jwtlib:8005</code></td>
</tr>
</tbody>
</table>
<hr />
<h2 id="services-sites-type-b">Services &amp; sites (Type B)</h2>
<p>A container image pushed to the registry and run on the Docker host. Version
source is the <code>VERSION</code> file; Drone file is <code>service-docker.yaml</code>.</p>
<table>
<thead>
<tr>
<th>Repo</th>
<th>Type</th>
<th>Path</th>
<th>Trigger</th>
<th>Docs</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>auth-server</code></td>
<td>service</td>
<td><code>auth-server</code></td>
<td>tag</td>
<td>api, lib, wiki</td>
</tr>
<tr>
<td><code>docs</code></td>
<td>site</td>
<td><code>docs</code></td>
<td>push</td>
<td>—</td>
</tr>
<tr>
<td><code>mcp</code></td>
<td>site</td>
<td><code>mcp</code></td>
<td>push</td>
<td>—</td>
</tr>
</tbody>
</table>
<p>The <strong>service</strong> variant is tag-triggered and enforces <code>tag == VERSION</code>. The
<strong>site</strong> variant is push-triggered, ships <code>:latest</code>, and has no tag guard.</p>
<hr />
<h2 id="required-files-per-repo">Required files per repo</h2>
<table>
<thead>
<tr>
<th>Type</th>
<th>Version source</th>
<th>Changelog</th>
<th>Drone</th>
</tr>
</thead>
<tbody>
<tr>
<td>package</td>
<td><code>pyproject.toml</code></td>
<td><code>CHANGELOG.md</code></td>
<td><code>python-lib.yaml</code></td>
</tr>
<tr>
<td>service / site</td>
<td><code>VERSION</code></td>
<td><code>CHANGELOG.md</code></td>
<td><code>service-docker.yaml</code></td>
</tr>
</tbody>
</table>
<p>Every covered repository must be able to satisfy <code>tag == version</code>:
the version file (never a commit id) is bumped in the release MR, the MR is
merged, and the tag is created on the merged commit.</p>
<hr />
<h2 id="reading-this-at-runtime">Reading this at runtime</h2>
<ul>
<li>Resource: <code>registry://repos</code></li>
<li>Tool: <code>list_repos()</code></li>
<li>Humans: this page (mirror of <code>standards/src/repos.json</code>).</li>
</ul>
<hr />
<h2 id="related">Related</h2>
<ul>
<li><a href="../10_drone_pipelines/">10 – Drone Pipelines</a> · <a href="../11_versioning_and_changelog/">11 – Versioning &amp; Changelog</a> · <a href="../13_library_registry/">13 – Library Registry</a></li>
</ul>
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>

22
standards/lib/404.html
View File

@@ -479,6 +479,28 @@
<li class="md-nav__item">
<a href="/15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="/12_genericity_matrix/" class="md-nav__link"> <a href="/12_genericity_matrix/" class="md-nav__link">

24
standards/lib/index.html
View File

@@ -496,6 +496,28 @@
<li class="md-nav__item">
<a href="15_repository_inventory/" class="md-nav__link">
<span class="md-ellipsis">
Repository Inventory
</span>
</a>
</li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="12_genericity_matrix/" class="md-nav__link"> <a href="12_genericity_matrix/" class="md-nav__link">
@@ -608,6 +630,8 @@ patterns, and the internal library catalog that agents consult while coding.</p>
<li><strong>Drone Pipelines</strong> — the two CI shapes: a PyPI package or a Docker deployment.</li> <li><strong>Drone Pipelines</strong> — the two CI shapes: a PyPI package or a Docker deployment.</li>
<li><strong>Versioning &amp; Changelog</strong> — SemVer, the tag↔version contract, and the release <li><strong>Versioning &amp; Changelog</strong> — SemVer, the tag↔version contract, and the release
changelog.</li> changelog.</li>
<li><strong>Repository Inventory</strong> — every covered repo, its type, version source, and
Drone shape.</li>
<li><strong>Genericity Matrix</strong> — what is library-backed, template-provided, or authored.</li> <li><strong>Genericity Matrix</strong> — what is library-backed, template-provided, or authored.</li>
<li><strong>Auth Integration</strong> — consuming the shared auth-server service (spec-driven, <li><strong>Auth Integration</strong> — consuming the shared auth-server service (spec-driven,
no auth code).</li> no auth code).</li>

2
standards/lib/search/search_index.json
View File

File diff suppressed because one or more lines are too long

2
standards/mcp/index.json
View File

@@ -1,6 +1,6 @@
{ {
"project": "standards", "project": "standards",
"type": "standards", "type": "standards",
"modules_count": 15, "modules_count": 16,
"source": "hand-authored" "source": "hand-authored"
} }

2
standards/mcp/modules/index.json
View File

@@ -2,7 +2,7 @@
"module": "index", "module": "index",
"content": { "content": {
"path": "index", "path": "index",
"docstring": "# Standards Reference\n\nThe reference half of the Standards description: the enforceable rules,\npatterns, and the internal library catalog that agents consult while coding.\n\n- **Build Recipe** — the ordered, agentic checklist for a new app.\n- **Layering Rules** — the strict request → domain → repository layering and\n the rules that enforce it.\n- **Composition Root** — a single composition point wiring the whole app.\n- **Spec-First Routing** — the OpenAPI contract as the routing source of truth.\n- **CRUD Template** — the standardized generic resource endpoint scaffold.\n- **Pipeline Scaffold** — the deterministic pipeline skeleton for multi-stage\n jobs.\n- **Worker & Progress** — queued work, progress reporting, and visibility.\n- **Human-in-the-Loop** — guardrails and approvals inside automations.\n- **Infra Adapters** — how infrastructure connects without leaking into domain.\n- **Drone Pipelines** — the two CI shapes: a PyPI package or a Docker deployment.\n- **Versioning & Changelog** — SemVer, the tag↔version contract, and the release\n changelog.\n- **Genericity Matrix** — what is library-backed, template-provided, or authored.\n- **Auth Integration** — consuming the shared auth-server service (spec-driven,\n no auth code).\n- **Library Registry** — the catalog of internal libraries behind all of it.\n\nRead the **Wiki** for the philosophy and rationale; these pages are the\nreference that mirrors the `standards` MCP bundle.\n", "docstring": "# Standards Reference\n\nThe reference half of the Standards description: the enforceable rules,\npatterns, and the internal library catalog that agents consult while coding.\n\n- **Build Recipe** — the ordered, agentic checklist for a new app.\n- **Layering Rules** — the strict request → domain → repository layering and\n the rules that enforce it.\n- **Composition Root** — a single composition point wiring the whole app.\n- **Spec-First Routing** — the OpenAPI contract as the routing source of truth.\n- **CRUD Template** — the standardized generic resource endpoint scaffold.\n- **Pipeline Scaffold** — the deterministic pipeline skeleton for multi-stage\n jobs.\n- **Worker & Progress** — queued work, progress reporting, and visibility.\n- **Human-in-the-Loop** — guardrails and approvals inside automations.\n- **Infra Adapters** — how infrastructure connects without leaking into domain.\n- **Drone Pipelines** — the two CI shapes: a PyPI package or a Docker deployment.\n- **Versioning & Changelog** — SemVer, the tag↔version contract, and the release\n changelog.\n- **Repository Inventory** — every covered repo, its type, version source, and\n Drone shape.\n- **Genericity Matrix** — what is library-backed, template-provided, or authored.\n- **Auth Integration** — consuming the shared auth-server service (spec-driven,\n no auth code).\n- **Library Registry** — the catalog of internal libraries behind all of it.\n\nRead the **Wiki** for the philosophy and rationale; these pages are the\nreference that mirrors the `standards` MCP bundle.\n",
"objects": {} "objects": {}
} }
} }

8
standards/mcp/modules/repository_inventory.json Normal file
View File

@@ -0,0 +1,8 @@
{
"module": "repository_inventory",
"content": {
"path": "repository_inventory",
"docstring": "# Repository Inventory\n\n## Summary\n\nThe canonical list of Aetos repositories covered by the CI and versioning\nstandards, with the artifact each one produces, its version source, and its\nDrone shape. Every entry maps to the contract in\n[11 – Versioning & Changelog](11_versioning_and_changelog.md) and the two CI\nfiles in [10 – Drone Pipelines](10_drone_pipelines.md).\n\nThe same data is published machine-readably as the `registry://repos` MCP\nresource (and the `list_repos` tool), sourced from `standards/src/repos.json`.\nPaths are relative to the `aetos/` workspace root.\n\n---\n\n## Packages (Type A)\n\nA wheel + sdist published to the private index. Version source is\n`pyproject.toml`; Drone file is `python-lib.yaml` (tag-triggered).\n\n| Repo | Path | Docs | MCP server |\n|------|------|------|------------|\n| `dagpipe` | `dagpipe` | lib, wiki | `dagpipe:8006` |\n| `doc-forge` | `doc-forge` | lib, wiki | `docforge:8001` |\n| `hexa` | `hexa` | lib, wiki | `hexa:8008` |\n| `mail-intake` | `mail-intake` | lib, wiki | `mail_intake:8002` |\n| `mongo-ops` | `mongo-ops` | lib, wiki | `mongo_ops:8007` |\n| `omniread` | `omniread` | lib, wiki | `omniread:8003` |\n| `openapi-first` | `openapi-first` | lib, wiki | `openapi_first:8004` |\n| `py-jwt` | `py-jwt` | lib, wiki | `jwtlib:8005` |\n\n---\n\n## Services & sites (Type B)\n\nA container image pushed to the registry and run on the Docker host. Version\nsource is the `VERSION` file; Drone file is `service-docker.yaml`.\n\n| Repo | Type | Path | Trigger | Docs |\n|------|------|------|---------|------|\n| `auth-server` | service | `auth-server` | tag | api, lib, wiki |\n| `docs` | site | `docs` | push | — |\n| `mcp` | site | `mcp` | push | — |\n\nThe **service** variant is tag-triggered and enforces `tag == VERSION`. The\n**site** variant is push-triggered, ships `:latest`, and has no tag guard.\n\n---\n\n## Required files per repo\n\n| Type | Version source | Changelog | Drone |\n|------|----------------|-----------|-------|\n| package | `pyproject.toml` | `CHANGELOG.md` | `python-lib.yaml` |\n| service / site | `VERSION` | `CHANGELOG.md` | `service-docker.yaml` |\n\nEvery covered repository must be able to satisfy `tag == version`:\nthe version file (never a commit id) is bumped in the release MR, the MR is\nmerged, and the tag is created on the merged commit.\n\n---\n\n## Reading this at runtime\n\n- Resource: `registry://repos`\n- Tool: `list_repos()`\n- Humans: this page (mirror of `standards/src/repos.json`).\n\n---\n\n## Related\n\n- [10 – Drone Pipelines](10_drone_pipelines.md) · [11 – Versioning & Changelog](11_versioning_and_changelog.md) · [13 – Library Registry](13_library_registry.md)\n",
"objects": {}
}
}

2
standards/mcp/modules/versioning_and_changelog.json
View File

File diff suppressed because one or more lines are too long

5
standards/mcp/nav.json
View File

@@ -69,6 +69,11 @@
"resource": "docs://modules/auth_integration", "resource": "docs://modules/auth_integration",
"title": "Auth Integration" "title": "Auth Integration"
}, },
{
"module": "repository_inventory",
"resource": "docs://modules/repository_inventory",
"title": "Repository Inventory"
},
{ {
"module": "index", "module": "index",
"resource": "docs://modules/index", "resource": "docs://modules/index",

169
standards/mcp/repos.json Normal file
View File

@@ -0,0 +1,169 @@
{
"project": "standards",
"note": "Machine-readable repository inventory. Mirrors standards/src/lib/15_repository_inventory.md. Read it with the registry://repos resource or the list_repos tool.",
"path_convention": "relative to the aetos/ workspace root",
"repos": [
{
"name": "dagpipe",
"type": "package",
"path": "dagpipe",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": [
"lib",
"wiki"
],
"mcp": {
"server": "dagpipe",
"port": 8006
}
},
{
"name": "doc-forge",
"type": "package",
"path": "doc-forge",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": [
"lib",
"wiki"
],
"mcp": {
"server": "docforge",
"port": 8001
}
},
{
"name": "hexa",
"type": "package",
"path": "hexa",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": [
"lib",
"wiki"
],
"mcp": {
"server": "hexa",
"port": 8008
}
},
{
"name": "mail-intake",
"type": "package",
"path": "mail-intake",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": [
"lib",
"wiki"
],
"mcp": {
"server": "mail_intake",
"port": 8002
}
},
{
"name": "mongo-ops",
"type": "package",
"path": "mongo-ops",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": [
"lib",
"wiki"
],
"mcp": {
"server": "mongo_ops",
"port": 8007
}
},
{
"name": "omniread",
"type": "package",
"path": "omniread",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": [
"lib",
"wiki"
],
"mcp": {
"server": "omniread",
"port": 8003
}
},
{
"name": "openapi-first",
"type": "package",
"path": "openapi-first",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": [
"lib",
"wiki"
],
"mcp": {
"server": "openapi_first",
"port": 8004
}
},
{
"name": "py-jwt",
"type": "package",
"path": "py-jwt",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": [
"lib",
"wiki"
],
"mcp": {
"server": "jwtlib",
"port": 8005
}
},
{
"name": "auth-server",
"type": "service",
"path": "auth-server",
"version_source": "VERSION",
"drone": "service-docker.yaml",
"trigger": "tag",
"docs": [
"api",
"lib",
"wiki"
],
"mcp": null
},
{
"name": "docs",
"type": "site",
"path": "docs",
"version_source": "VERSION",
"drone": "service-docker.yaml",
"trigger": "push",
"docs": [],
"mcp": null
},
{
"name": "mcp",
"type": "site",
"path": "mcp",
"version_source": "VERSION",
"drone": "service-docker.yaml",
"trigger": "push",
"docs": [],
"mcp": null
}
]
}

9
standards/mcp/templates/release/CHANGELOG.md
View File

@@ -20,16 +20,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Security ### Security
<!-- <!--
On release, promote the entries above into a new heading with today's date and In the release merge request, promote the entries above into a new heading and
leave a fresh, empty [Unreleased] section: leave a fresh, empty [Unreleased] section. Name the version/tag, never a commit
id:
## [0.1.0] - YYYY-MM-DD ## [0.1.0] - YYYY-MM-DD
### Added ### Added
- Initial release. - Initial release.
Then update the compare links below. See the standard: Then update the compare links below. The tag is created on the merged commit —
Versioning & Changelog (registry://release). see the standard: Versioning & Changelog (registry://release).
--> -->
[Unreleased]: <repo-url>/compare/0.1.0...HEAD [Unreleased]: <repo-url>/compare/0.1.0...HEAD

62
standards/src/lib/11_versioning_and_changelog.md
View File

@@ -27,8 +27,9 @@ Rules:
2. **Tag = version.** The git tag is bare SemVer (`0.0.6`), no `v` prefix, and 2. **Tag = version.** The git tag is bare SemVer (`0.0.6`), no `v` prefix, and
it MUST match the version file byte-for-byte. The Drone guard fails the it MUST match the version file byte-for-byte. The Drone guard fails the
build otherwise — this is what stops a tag from silently publishing nothing. build otherwise — this is what stops a tag from silently publishing nothing.
3. **A release is a tag.** Bump the version file, promote the changelog, commit, 3. **A release is a tag, created after the change is merged.** The version bump
tag, push. Everything else is automated by Drone. and the changelog promotion travel inside the merge request (MR); the tag is
added on the merged commit and pushed. See [Tagging strategy](#tagging-strategy-mr-based).
4. **Never reuse a tag.** If a release is wrong, cut a new patch version. 4. **Never reuse a tag.** If a release is wrong, cut a new patch version.
### Pre-1.0 (0.y.z) ### Pre-1.0 (0.y.z)
@@ -88,17 +89,54 @@ Conventions:
--- ---
## Tagging strategy (MR-based)
The release version is known while the change is still a merge request, so the
bump travels with the change and only the tag is added afterwards:
1. **In the MR** — set the intended release version: `version` in
`pyproject.toml` (or the `VERSION` file) to `x.y.z`, and promote the
changelog (below). Changelog entries and link references name the
**version/tag**, never a commit id.
2. **Merge or squash** the MR into `main`.
3. **Create the tag** `x.y.z` on the resulting commit (the merge/squash commit).
4. **Push the tag** (`git push origin x.y.z`) — Drone builds the release.
Because the version bump is inside the tagged commit, the guard's
`tag == version` check can only fail if the wrong commit was tagged.
### Agent-assisted tagging
The agent neither authors nor merges the MR, and never tags before the merge.
After the user confirms the MR is merged/squashed and says to proceed:
1. **Wait** for that explicit go-ahead.
2. Find the commit that introduced the version bump:
- packages:
`git log -S 'version = "x.y.z"' -n 1 --format='%H %s' -- pyproject.toml`
- services:
`git log -S 'x.y.z' -n 1 --format='%H %s' -- VERSION`
3. Confirm that commit's version file equals `x.y.z`, then tag **only** that
commit, lightweight and bare: `git tag x.y.z <sha>`.
4. **Do not push.** Ask the user to push the tag: `git push origin x.y.z`.
---
## Release checklist ## Release checklist
1. Confirm the quality gate is green on `main`. 1. Confirm the quality gate is green and `main` is up to date.
2. Move every `[Unreleased]` entry under the new version heading with today's 2. In the MR: move every `[Unreleased]` entry under the new version heading with
date (`## [x.y.z] - YYYY-MM-DD`); restore an empty `[Unreleased]` on top. the target date (`## [x.y.z] - YYYY-MM-DD`); restore an empty `[Unreleased]`
3. Add the two compare-link references at the bottom of the changelog. on top.
4. Set the version file: `pyproject.toml` (`version = "x.y.z"`) or `VERSION`. 3. In the MR: add the two compare-link references at the bottom of the
5. Commit: `chore(release): x.y.z`. changelog, naming the version/tag (never a commit id).
6. Tag: `git tag x.y.z` and push the tag (`git push origin x.y.z`). 4. In the MR: set the version file — `pyproject.toml` (`version = "x.y.z"`) or
7. Watch Drone: Type A publishes the wheel/sdist, Type B builds and deploys the `VERSION` — to the intended release version.
image. Both first assert `tag == version`. 5. Merge or squash the MR into `main`.
6. Create the tag on the resulting commit: lightweight `git tag x.y.z`.
7. Push the tag (`git push origin x.y.z`). Watch Drone: Type A publishes the
wheel/sdist, Type B builds and deploys the image; both first assert
`tag == version`.
8. Do not reuse the tag if the run fails — fix and cut `x.y.(z+1)`. 8. Do not reuse the tag if the run fails — fix and cut `x.y.(z+1)`.
--- ---
@@ -116,4 +154,4 @@ Drone guard turns that silent no-op into a hard failure.
## Related ## Related
- [10 – Drone Pipelines](10_drone_pipelines.md) · [01 – Build Recipe](01_build_recipe.md) · [13 – Library Registry](13_library_registry.md) - [10 – Drone Pipelines](10_drone_pipelines.md) · [15 – Repository Inventory](15_repository_inventory.md) · [01 – Build Recipe](01_build_recipe.md) · [13 – Library Registry](13_library_registry.md)

74
standards/src/lib/15_repository_inventory.md Normal file
View File

@@ -0,0 +1,74 @@
# Repository Inventory
## Summary
The canonical list of Aetos repositories covered by the CI and versioning
standards, with the artifact each one produces, its version source, and its
Drone shape. Every entry maps to the contract in
[11 – Versioning & Changelog](11_versioning_and_changelog.md) and the two CI
files in [10 – Drone Pipelines](10_drone_pipelines.md).
The same data is published machine-readably as the `registry://repos` MCP
resource (and the `list_repos` tool), sourced from `standards/src/repos.json`.
Paths are relative to the `aetos/` workspace root.
---
## Packages (Type A)
A wheel + sdist published to the private index. Version source is
`pyproject.toml`; Drone file is `python-lib.yaml` (tag-triggered).
| Repo | Path | Docs | MCP server |
|------|------|------|------------|
| `dagpipe` | `dagpipe` | lib, wiki | `dagpipe:8006` |
| `doc-forge` | `doc-forge` | lib, wiki | `docforge:8001` |
| `hexa` | `hexa` | lib, wiki | `hexa:8008` |
| `mail-intake` | `mail-intake` | lib, wiki | `mail_intake:8002` |
| `mongo-ops` | `mongo-ops` | lib, wiki | `mongo_ops:8007` |
| `omniread` | `omniread` | lib, wiki | `omniread:8003` |
| `openapi-first` | `openapi-first` | lib, wiki | `openapi_first:8004` |
| `py-jwt` | `py-jwt` | lib, wiki | `jwtlib:8005` |
---
## Services & sites (Type B)
A container image pushed to the registry and run on the Docker host. Version
source is the `VERSION` file; Drone file is `service-docker.yaml`.
| Repo | Type | Path | Trigger | Docs |
|------|------|------|---------|------|
| `auth-server` | service | `auth-server` | tag | api, lib, wiki |
| `docs` | site | `docs` | push | — |
| `mcp` | site | `mcp` | push | — |
The **service** variant is tag-triggered and enforces `tag == VERSION`. The
**site** variant is push-triggered, ships `:latest`, and has no tag guard.
---
## Required files per repo
| Type | Version source | Changelog | Drone |
|------|----------------|-----------|-------|
| package | `pyproject.toml` | `CHANGELOG.md` | `python-lib.yaml` |
| service / site | `VERSION` | `CHANGELOG.md` | `service-docker.yaml` |
Every covered repository must be able to satisfy `tag == version`:
the version file (never a commit id) is bumped in the release MR, the MR is
merged, and the tag is created on the merged commit.
---
## Reading this at runtime
- Resource: `registry://repos`
- Tool: `list_repos()`
- Humans: this page (mirror of `standards/src/repos.json`).
---
## Related
- [10 – Drone Pipelines](10_drone_pipelines.md) · [11 – Versioning & Changelog](11_versioning_and_changelog.md) · [13 – Library Registry](13_library_registry.md)

2
standards/src/lib/index.md
View File

@@ -17,6 +17,8 @@ patterns, and the internal library catalog that agents consult while coding.
- **Drone Pipelines** — the two CI shapes: a PyPI package or a Docker deployment. - **Drone Pipelines** — the two CI shapes: a PyPI package or a Docker deployment.
- **Versioning & Changelog** — SemVer, the tag↔version contract, and the release - **Versioning & Changelog** — SemVer, the tag↔version contract, and the release
changelog. changelog.
- **Repository Inventory** — every covered repo, its type, version source, and
Drone shape.
- **Genericity Matrix** — what is library-backed, template-provided, or authored. - **Genericity Matrix** — what is library-backed, template-provided, or authored.
- **Auth Integration** — consuming the shared auth-server service (spec-driven, - **Auth Integration** — consuming the shared auth-server service (spec-driven,
no auth code). no auth code).

1
standards/src/mkdocs.lib.yml
View File

@@ -65,6 +65,7 @@ nav:
- Infra Adapters: 09_infra_adaptors.md - Infra Adapters: 09_infra_adaptors.md
- Drone Pipelines: 10_drone_pipelines.md - Drone Pipelines: 10_drone_pipelines.md
- Versioning & Changelog: 11_versioning_and_changelog.md - Versioning & Changelog: 11_versioning_and_changelog.md
- Repository Inventory: 15_repository_inventory.md
- Genericity Matrix: 12_genericity_matrix.md - Genericity Matrix: 12_genericity_matrix.md
- Auth Integration: 14_auth_integration.md - Auth Integration: 14_auth_integration.md
- Library Registry: 13_library_registry.md - Library Registry: 13_library_registry.md

117
standards/src/repos.json Normal file
View File

@@ -0,0 +1,117 @@
{
"project": "standards",
"note": "Machine-readable repository inventory. Mirrors standards/src/lib/15_repository_inventory.md. Read it with the registry://repos resource or the list_repos tool.",
"path_convention": "relative to the aetos/ workspace root",
"repos": [
{
"name": "dagpipe",
"type": "package",
"path": "dagpipe",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": ["lib", "wiki"],
"mcp": { "server": "dagpipe", "port": 8006 }
},
{
"name": "doc-forge",
"type": "package",
"path": "doc-forge",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": ["lib", "wiki"],
"mcp": { "server": "docforge", "port": 8001 }
},
{
"name": "hexa",
"type": "package",
"path": "hexa",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": ["lib", "wiki"],
"mcp": { "server": "hexa", "port": 8008 }
},
{
"name": "mail-intake",
"type": "package",
"path": "mail-intake",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": ["lib", "wiki"],
"mcp": { "server": "mail_intake", "port": 8002 }
},
{
"name": "mongo-ops",
"type": "package",
"path": "mongo-ops",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": ["lib", "wiki"],
"mcp": { "server": "mongo_ops", "port": 8007 }
},
{
"name": "omniread",
"type": "package",
"path": "omniread",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": ["lib", "wiki"],
"mcp": { "server": "omniread", "port": 8003 }
},
{
"name": "openapi-first",
"type": "package",
"path": "openapi-first",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": ["lib", "wiki"],
"mcp": { "server": "openapi_first", "port": 8004 }
},
{
"name": "py-jwt",
"type": "package",
"path": "py-jwt",
"version_source": "pyproject.toml",
"drone": "python-lib.yaml",
"trigger": "tag",
"docs": ["lib", "wiki"],
"mcp": { "server": "jwtlib", "port": 8005 }
},
{
"name": "auth-server",
"type": "service",
"path": "auth-server",
"version_source": "VERSION",
"drone": "service-docker.yaml",
"trigger": "tag",
"docs": ["api", "lib", "wiki"],
"mcp": null
},
{
"name": "docs",
"type": "site",
"path": "docs",
"version_source": "VERSION",
"drone": "service-docker.yaml",
"trigger": "push",
"docs": [],
"mcp": null
},
{
"name": "mcp",
"type": "site",
"path": "mcp",
"version_source": "VERSION",
"drone": "service-docker.yaml",
"trigger": "push",
"docs": [],
"mcp": null
}
]
}

9
standards/src/templates/release/CHANGELOG.md
View File

@@ -20,16 +20,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Security ### Security
<!-- <!--
On release, promote the entries above into a new heading with today's date and In the release merge request, promote the entries above into a new heading and
leave a fresh, empty [Unreleased] section: leave a fresh, empty [Unreleased] section. Name the version/tag, never a commit
id:
## [0.1.0] - YYYY-MM-DD ## [0.1.0] - YYYY-MM-DD
### Added ### Added
- Initial release. - Initial release.
Then update the compare links below. See the standard: Then update the compare links below. The tag is created on the merged commit —
Versioning & Changelog (registry://release). see the standard: Versioning & Changelog (registry://release).
--> -->
[Unreleased]: <repo-url>/compare/0.1.0...HEAD [Unreleased]: <repo-url>/compare/0.1.0...HEAD

60
standards/src/wiki/04_development/02_releasing.md
View File

@@ -5,14 +5,16 @@ page [Versioning & Changelog](../lib/11_versioning_and_changelog/); this is the
runbook you follow. runbook you follow.
Every repository is one of two Drone shapes — a **PyPI package** or a **Docker Every repository is one of two Drone shapes — a **PyPI package** or a **Docker
deployment** ([Drone Pipelines](../lib/10_drone_pipelines/)). Both are deployment** ([Drone Pipelines](../lib/10_drone_pipelines/)). Both release the
released the same way: bump the version file, promote the changelog, tag. same way: the version bump and changelog promotion go **in the merge request**,
and the tag is created on the merged commit.
--- ---
## 🧾 Before you start ## 🧾 Before you start
- `main` is green (the Drone quality gate passed on the last run). - You have an open **merge request** holding the change, and `main` is green
(the Drone quality gate passed on the last run).
- You know whether this is a **breaking**, **feature**, or **fix** release. - You know whether this is a **breaking**, **feature**, or **fix** release.
- The version file exists: - The version file exists:
- package → `version` in `pyproject.toml` - package → `version` in `pyproject.toml`
@@ -33,36 +35,46 @@ line (see the reference page); once at `1.0.0`, normal SemVer applies.
--- ---
## ✍️ Promote the changelog ## 🌿 Release in the MR
In `CHANGELOG.md`: The version is known while the change is still a merge request, so the bump
rides along with it. Do both edits **in the MR**:
1. Rename the content under `[Unreleased]` into a new - **Promote the changelog** in `CHANGELOG.md`: move the `[Unreleased]` content
`## [x.y.z] - YYYY-MM-DD` heading (keep the sections that apply). under a new `## [x.y.z] - YYYY-MM-DD` heading, leave a fresh empty
2. Leave a fresh, empty `## [Unreleased]` on top. `[Unreleased]` on top, and add the compare links — naming the **version/tag**,
3. Add the compare links at the bottom: never a commit id:
```markdown ```markdown
[Unreleased]: https://git.aetoskia.com/aetos/<repo>/compare/x.y.z...HEAD [Unreleased]: https://git.aetoskia.com/aetos/<repo>/compare/x.y.z...HEAD
[x.y.z]: https://git.aetoskia.com/aetos/<repo>/compare/x.y.(z-1)...x.y.z [x.y.z]: https://git.aetoskia.com/aetos/<repo>/compare/x.y.(z-1)...x.y.z
``` ```
- **Bump the version file** to the intended release version: `version = "x.y.z"`
in `pyproject.toml` (packages) or the `VERSION` file (services/sites).
--- ---
## 🔢 Bump the version file ## 🏷️ Tag the merged commit
- **Package:** edit `version = "x.y.z"` in `pyproject.toml`. 1. **Merge or squash** the MR into `main`.
- **Service / site:** edit the `VERSION` file. 2. **Create the tag** on the resulting commit: `git tag x.y.z` (lightweight).
3. **Push the tag** (`git push origin x.y.z`) — Drone builds the release.
Then commit and tag: ### 🤖 Agent-assisted tagging
```bash The agent does not author or merge the MR and never tags before the merge. After
git add CHANGELOG.md pyproject.toml # or VERSION you confirm the MR is merged/squashed and tell it to proceed, the agent:
git commit -m "chore(release): x.y.z"
git tag x.y.z 1. Waits for that explicit go-ahead.
git push origin HEAD 2. Finds the commit that introduced the bump:
git push origin x.y.z - package:
``` `git log -S 'version = "x.y.z"' -n 1 --format='%H %s' -- pyproject.toml`
- service / site:
`git log -S 'x.y.z' -n 1 --format='%H %s' -- VERSION`
3. Verifies that commit's version file equals `x.y.z`, then tags **only** that
commit: `git tag x.y.z <sha>`.
4. Does **not** push — it asks you to run `git push origin x.y.z`.
--- ---

86
standards/wiki/04_development/02_releasing/index.html
View File

@@ -528,21 +528,36 @@
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="#promote-the-changelog" class="md-nav__link"> <a href="#release-in-the-mr" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
✍️ Promote the changelog 🌿 Release in the MR
</span> </span>
</a> </a>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
<a href="#bump-the-version-file" class="md-nav__link"> <a href="#tag-the-merged-commit" class="md-nav__link">
<span class="md-ellipsis"> <span class="md-ellipsis">
🔢 Bump the version file 🏷️ Tag the merged commit
</span> </span>
</a> </a>
<nav class="md-nav" aria-label="🏷️ Tag the merged commit">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#agent-assisted-tagging" class="md-nav__link">
<span class="md-ellipsis">
🤖 Agent-assisted tagging
</span>
</a>
</li>
</ul>
</nav>
</li> </li>
<li class="md-nav__item"> <li class="md-nav__item">
@@ -610,12 +625,14 @@
page <a href="../lib/11_versioning_and_changelog/">Versioning &amp; Changelog</a>; this is the page <a href="../lib/11_versioning_and_changelog/">Versioning &amp; Changelog</a>; this is the
runbook you follow.</p> runbook you follow.</p>
<p>Every repository is one of two Drone shapes — a <strong>PyPI package</strong> or a <strong>Docker <p>Every repository is one of two Drone shapes — a <strong>PyPI package</strong> or a <strong>Docker
deployment</strong> (<a href="../lib/10_drone_pipelines/">Drone Pipelines</a>). Both are deployment</strong> (<a href="../lib/10_drone_pipelines/">Drone Pipelines</a>). Both release the
released the same way: bump the version file, promote the changelog, tag.</p> same way: the version bump and changelog promotion go <strong>in the merge request</strong>,
and the tag is created on the merged commit.</p>
<hr /> <hr />
<h2 id="before-you-start">🧾 Before you start</h2> <h2 id="before-you-start">🧾 Before you start</h2>
<ul> <ul>
<li><code>main</code> is green (the Drone quality gate passed on the last run).</li> <li>You have an open <strong>merge request</strong> holding the change, and <code>main</code> is green
(the Drone quality gate passed on the last run).</li>
<li>You know whether this is a <strong>breaking</strong>, <strong>feature</strong>, or <strong>fix</strong> release.</li> <li>You know whether this is a <strong>breaking</strong>, <strong>feature</strong>, or <strong>fix</strong> release.</li>
<li>The version file exists:</li> <li>The version file exists:</li>
<li>package → <code>version</code> in <code>pyproject.toml</code></li> <li>package → <code>version</code> in <code>pyproject.toml</code></li>
@@ -652,35 +669,44 @@ line (see the reference page); once at <code>1.0.0</code>, normal SemVer applies
</tbody> </tbody>
</table> </table>
<hr /> <hr />
<h2 id="promote-the-changelog">✍️ Promote the changelog</h2> <h2 id="release-in-the-mr">🌿 Release in the MR</h2>
<p>In <code>CHANGELOG.md</code>:</p> <p>The version is known while the change is still a merge request, so the bump
<ol> rides along with it. Do both edits <strong>in the MR</strong>:</p>
<li>Rename the content under <code>[Unreleased]</code> into a new <ul>
<code>## [x.y.z] - YYYY-MM-DD</code> heading (keep the sections that apply).</li> <li><strong>Promote the changelog</strong> in <code>CHANGELOG.md</code>: move the <code>[Unreleased]</code> content
<li>Leave a fresh, empty <code>## [Unreleased]</code> on top.</li> under a new <code>## [x.y.z] - YYYY-MM-DD</code> heading, leave a fresh empty
<li>Add the compare links at the bottom:</li> <code>[Unreleased]</code> on top, and add the compare links — naming the <strong>version/tag</strong>,
</ol> never a commit id:</li>
</ul>
<div class="language-markdown highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span> <div class="language-markdown highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
<span class="normal"><a href="#__codelineno-0-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a>[<span class="nl">Unreleased</span>]: <span class="na">https://git.aetoskia.com/aetos/&lt;repo&gt;/compare/x.y.z...HEAD</span> <span class="normal"><a href="#__codelineno-0-2">2</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a>[<span class="nl">Unreleased</span>]: <span class="na">https://git.aetoskia.com/aetos/&lt;repo&gt;/compare/x.y.z...HEAD</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a>[<span class="nl">x.y.z</span>]: <span class="na">https://git.aetoskia.com/aetos/&lt;repo&gt;/compare/x.y.(z-1)...x.y.z</span> </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a>[<span class="nl">x.y.z</span>]: <span class="na">https://git.aetoskia.com/aetos/&lt;repo&gt;/compare/x.y.(z-1)...x.y.z</span>
</span></code></pre></div></td></tr></table></div> </span></code></pre></div></td></tr></table></div>
<hr />
<h2 id="bump-the-version-file">🔢 Bump the version file</h2>
<ul> <ul>
<li><strong>Package:</strong> edit <code>version = "x.y.z"</code> in <code>pyproject.toml</code>.</li> <li><strong>Bump the version file</strong> to the intended release version: <code>version = "x.y.z"</code>
<li><strong>Service / site:</strong> edit the <code>VERSION</code> file.</li> in <code>pyproject.toml</code> (packages) or the <code>VERSION</code> file (services/sites).</li>
</ul> </ul>
<p>Then commit and tag:</p> <hr />
<div class="language-bash highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-1-1">1</a></span> <h2 id="tag-the-merged-commit">🏷️ Tag the merged commit</h2>
<span class="normal"><a href="#__codelineno-1-2">2</a></span> <ol>
<span class="normal"><a href="#__codelineno-1-3">3</a></span> <li><strong>Merge or squash</strong> the MR into <code>main</code>.</li>
<span class="normal"><a href="#__codelineno-1-4">4</a></span> <li><strong>Create the tag</strong> on the resulting commit: <code>git tag x.y.z</code> (lightweight).</li>
<span class="normal"><a href="#__codelineno-1-5">5</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a>git<span class="w"> </span>add<span class="w"> </span>CHANGELOG.md<span class="w"> </span>pyproject.toml<span class="w"> </span><span class="c1"># or VERSION</span> <li><strong>Push the tag</strong> (<code>git push origin x.y.z</code>) — Drone builds the release.</li>
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2"></a>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">&quot;chore(release): x.y.z&quot;</span> </ol>
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3"></a>git<span class="w"> </span>tag<span class="w"> </span>x.y.z <h3 id="agent-assisted-tagging">🤖 Agent-assisted tagging</h3>
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4"></a>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>HEAD <p>The agent does not author or merge the MR and never tags before the merge. After
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5"></a>git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>x.y.z you confirm the MR is merged/squashed and tell it to proceed, the agent:</p>
</span></code></pre></div></td></tr></table></div> <ol>
<li>Waits for that explicit go-ahead.</li>
<li>Finds the commit that introduced the bump:</li>
<li>package:
<code>git log -S 'version = "x.y.z"' -n 1 --format='%H %s' -- pyproject.toml</code></li>
<li>service / site:
<code>git log -S 'x.y.z' -n 1 --format='%H %s' -- VERSION</code></li>
<li>Verifies that commit's version file equals <code>x.y.z</code>, then tags <strong>only</strong> that
commit: <code>git tag x.y.z &lt;sha&gt;</code>.</li>
<li>Does <strong>not</strong> push — it asks you to run <code>git push origin x.y.z</code>.</li>
</ol>
<hr /> <hr />
<h2 id="what-drone-does">🤖 What Drone does</h2> <h2 id="what-drone-does">🤖 What Drone does</h2>
<ul> <ul>

2
standards/wiki/search/search_index.json
View File

File diff suppressed because one or more lines are too long