docs: app-baseline-kit dependency patterns across the fleet - #2206
Merged
Conversation
Add docs/guides/BASELINE_KIT_DEPENDENCY.md as the catalog of accepted patterns for the shared app-baseline-kit dependency, plus a one-line link from the INTEGRATION_GUIDE monorepo-dependency callout. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Workflow source neededPR #2206 needs either a linked GitHub issue or one valid non-issue Workflow Source before PR metadata automation can manage it safely. Please do one of:
Once a valid source is present, this warning will not be reposted. |
Contributor
|
Gate fast-pass: docs-only change detected; heavy checks skipped. |
Contributor
Automated Status SummaryHead SHA: 5832745
Updated automatically; will refresh on subsequent CI/Docker completions. Keepalive checklistScopeNo scope information available Tasks
Acceptance criteria
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new documentation guide that defines accepted app-baseline-kit dependency patterns for consumer repos and links it from the integration guide.
Changes:
- Adds
docs/guides/BASELINE_KIT_DEPENDENCY.mdwith Pattern A/B/C/vendoring guidance and migration steps. - Adds an
INTEGRATION_GUIDE.mdcross-reference to the new dependency-pattern catalog. - Documents per-repo pattern mapping and decision order for future consumers.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
docs/INTEGRATION_GUIDE.md |
Adds a link from the monorepo dependency callout to the new guide. |
docs/guides/BASELINE_KIT_DEPENDENCY.md |
New reference catalog for app-baseline-kit dependency declaration patterns. |
| @@ -0,0 +1,203 @@ | |||
| # Declaring the `app-baseline-kit` Dependency | |||
Comment on lines
+30
to
+33
| - **Pattern C (frozen SHA) is deprecated.** A `pyproject.toml` that pins | ||
| `app-baseline-kit @ git+...@<sha>#...` is a stopgap, not a target state. Any | ||
| repo on Pattern C must migrate to Pattern A (it tracks Workflows `main` and | ||
| removes the SHA from the loop). See [Fixing a Pattern C repo](#fixing-a-pattern-c-repo-frozen-sha--pattern-a). |
Comment on lines
373
to
+378
| > Exclude it from `requirements.lock` with `[tool.uv.pip] no-emit-package` so a | ||
| > frozen SHA in the lock cannot conflict with the unpinned `@main` URL when | ||
| > Workflows `main` advances. See | ||
| > [Monorepo Package Dependencies](ops/CONSUMER_REPO_MAINTENANCE.md#monorepo-package-dependencies-app-baseline-kit). | ||
| > [Monorepo Package Dependencies](ops/CONSUMER_REPO_MAINTENANCE.md#monorepo-package-dependencies-app-baseline-kit), | ||
| > and [Declaring the `app-baseline-kit` Dependency](guides/BASELINE_KIT_DEPENDENCY.md) | ||
| > for the catalog of accepted patterns and how to choose one. |
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.
Summary
Adds
docs/guides/BASELINE_KIT_DEPENDENCY.md— the catalog of accepted patterns for pulling in the sharedapp-baseline-kitpackage (thebaseline_kitimport) acrossstranske/*consumer repos.The guide documents:
@maininpyproject.toml+[tool.uv.pip] no-emit-package, with thePension-Datalock-SHA variant.requirements-baseline.txtfor custom build backends (TPP).pyproject.toml— deprecated, with step-by-step migration to Pattern A.Inv-Man-Intake).It complements the operational walkthrough in
ops/CONSUMER_REPO_MAINTENANCE.md → Monorepo Package Dependencies(the conflict mechanics and no-emit fix) — that doc is for debugging install failures; this guide is for choosing a pattern.Also
INTEGRATION_GUIDE.mdmonorepo-dependency callout to the new pattern catalog.🤖 Generated with Claude Code