Skip to content

docs(gitops-api): onboarding repo-discovery design (F8)#213

Merged
sunib merged 1 commit into
mainfrom
feat/gitops-api-f8-design
Jul 9, 2026
Merged

docs(gitops-api): onboarding repo-discovery design (F8)#213
sunib merged 1 commit into
mainfrom
feat/gitops-api-f8-design

Conversation

@sunib

@sunib sunib commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Adds the F8 design — repo-wide GitTarget discovery in the manifest-analyzer CLI/library (never the operator) — and files the shipped F1/F7 docs under finished/, with inbound links and the feature ladder updated.

Docs-only; the first implementation lands in a follow-up PR.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • New Features

    • Added documentation for a new repo discovery and onboarding scan flow, including candidate detection, layout classification, and summary reporting.
  • Documentation

    • Updated GitOps API design docs and related references to reflect shipped items and corrected document locations.
    • Marked several design documents as shipped and refreshed cross-links for consistency.
    • Updated test fixture documentation links to match the new design-doc paths.

…ped F1/F7

Add the F8 design — repo-wide GitTarget discovery in the manifest-analyzer
CLI/library, never the operator — and move the shipped F1/F7 feature docs
into finished/, updating inbound links and the feature ladder.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 9, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Documentation updates move several shipped GitOps API design docs to a new finished/ subdirectory, updating cross-references across architecture, configuration, and design docs. A new F8 design document for repo discovery and onboarding scan is added, and the README's feature ladder is updated accordingly.

Changes

Documentation Updates

Layer / File(s) Summary
F1 design doc marked shipped, cross-reference updates
docs/design/gitops-api/finished/f1-images-replicas-edit-through.md, docs/architecture.md, docs/configuration.md, docs/design/gitops-api/kustomize-support-boundary-and-product-model.md, docs/design/gitops-api/unreflectable-edits-and-write-gating.md, internal/manifestanalyzer/testdata/contextual-namespace/README.md
F1 edit-through doc status changed to "shipped" with corrected relative links; all referencing docs updated to point to the finished/ path.
F7 design doc marked shipped, link fixes
docs/design/gitops-api/finished/f7-higher-level-krm-documents.md
F7 doc status changed to "shipped" with a PR reference, and internal links (watchrule types, e2e tests, Taskfile, user docs) updated to new relative paths.
New F8 repo discovery and onboarding scan doc
docs/design/gitops-api/f8-repo-discovery-and-onboarding-scan.md
New design document describing F8 as a CLI/library-layer capability, covering operator boundaries, discovery algorithm, layout classification, report contract, CLI surface, non-goals, ladder relation, test plan, and open questions.
README feature ladder update
docs/design/gitops-api/README.md
Adds an "Onboarding (CLI / library)" responsibility bullet, advances the feature-ladder baseline date, adds the F8 row, and updates F7 link path.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • ConfigButler/gitops-reverser#198: Adds the original F1 images/replicas edit-through design doc and related documentation that this PR relocates and updates links for.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is too sparse and omits most required template sections such as type, testing, checklist, and related issues. Fill out the template sections for Type of Change, Testing, Checklist, Related Issues, Screenshots, and Additional Notes.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: adding the F8 repo-discovery design in gitops-api docs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/gitops-api-f8-design

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/design/gitops-api/f8-repo-discovery-and-onboarding-scan.md`:
- Around line 120-125: Update the onboarding taxonomy so `kustomize-single`
matches the supported single-context Kustomize surface by including `bases`
alongside `namespace`, `resources`, `images`, and `replicas`. Adjust the table
in the design doc to reflect the same accepted inputs described by
`docs/configuration.md` and the README, ensuring any folder using local bases is
still recognized as valid by the `acceptedByOperator` logic.
- Around line 184-186: The prose in this design document contains a stray diff
marker before “CI gate”; remove the leading plus sign so the sentence reads as
normal markdown. Update the affected text near the “library function” discussion
to keep the wording clean and free of accidental patch syntax.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: a24b0819-f062-41fd-8137-4778c4657d34

📥 Commits

Reviewing files that changed from the base of the PR and between d364f25 and 18b870a.

📒 Files selected for processing (9)
  • docs/architecture.md
  • docs/configuration.md
  • docs/design/gitops-api/README.md
  • docs/design/gitops-api/f8-repo-discovery-and-onboarding-scan.md
  • docs/design/gitops-api/finished/f1-images-replicas-edit-through.md
  • docs/design/gitops-api/finished/f7-higher-level-krm-documents.md
  • docs/design/gitops-api/kustomize-support-boundary-and-product-model.md
  • docs/design/gitops-api/unreflectable-edits-and-write-gating.md
  • internal/manifestanalyzer/testdata/contextual-namespace/README.md

Comment thread docs/design/gitops-api/f8-repo-discovery-and-onboarding-scan.md
Comment thread docs/design/gitops-api/f8-repo-discovery-and-onboarding-scan.md
@codecov

codecov Bot commented Jul 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@sunib
sunib merged commit 4469e2b into main Jul 9, 2026
17 checks passed
@sunib
sunib deleted the feat/gitops-api-f8-design branch July 9, 2026 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant