general: T8595: add CLAUDE.md by andamasov · Pull Request #1172 · vyos/vyos-build

andamasov · 2026-04-28T20:21:55Z

Summary

Adds CLAUDE.md at repo root with project purpose, tech stack, build/test/run, repository layout, cross-repo context, conventions, mirror relationship, notes.
Generated 2026-04-26 from code + cross-org Confluence context. Mirrored at https://internal.confluence.vyos.com/wiki/spaces/VYOS/pages/818282892.
Tracked under T8595.

Test plan

Confirm CLAUDE.md renders.
CI passes.

🤖 Generated by robots

coderabbitai · 2026-04-28T20:22:03Z

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 846c9436-70a4-4098-bf3f-3865ad59d1bd

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Commit unit tests in branch T8595-add-claude-md

✨ Simplify code

Create PR with simplified code
Commit simplified code in branch T8595-add-claude-md

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

github-actions · 2026-04-28T20:22:10Z

👍
No issues in PR Title / Commit Title

Copilot

Pull request overview

Adds a new CLAUDE.md at the repository root to document the project’s purpose, tech stack, common build/test commands, repository layout, cross-repo dependencies, conventions, and mirroring context.

Changes:

Introduces CLAUDE.md with build/run/test quickstart and repo layout notes.
Documents cross-repo relationships (packages, live-build fork, smoketest harness).
Captures contribution conventions and mirroring guidance.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

+
+## Conventions
+- Commit/PR title: `component: T12345: description`. Phorge IDs at https://vyos.dev. Enforced by `check-pr-message.yml` reusable.
+- Linting: ruff, darker, unused-imports, J2 lint (note: workflow file is named `linit-j2.yml` in this repo — known cosmetic typo). All inherited from `vyos/.github@current`.


+## Conventions
+- Commit/PR title: `component: T12345: description`. Phorge IDs at https://vyos.dev. Enforced by `check-pr-message.yml` reusable.
+- Linting: ruff, darker, unused-imports, J2 lint (note: workflow file is named `linit-j2.yml` in this repo — known cosmetic typo). All inherited from `vyos/.github@current`.
+- Mergify config (`mergify.yml`) present: single rule that adds `conflicts` label.


+- Mergify config (`mergify.yml`) present: single rule that adds `conflicts` label.
+
+## Mirror relationship
+**Live consumer** of the gen-1 PR mirror pipeline (`pr-mirror-repo-sync.yml`). Mirror twin: `VyOS-Networks/vyos-build`. Edit canonical side only.


andamasov · 2026-04-29T15:53:19Z

@copilot review

…sections Agent-Logs-Url: https://github.com/vyos/vyos-build/sessions/d2b898d2-4bf7-448f-b7d5-6ff83eb7871a Co-authored-by: andamasov <12631358+andamasov@users.noreply.github.com>

Copilot · 2026-04-29T15:59:32Z

@copilot review

Addressed all three review issues in be0dbd8:

Linting list (line 38): Removed ruff and darker — neither appears in the repo's workflows. The section now accurately lists only unused-imports (Pylint) and J2 lint, both inherited from vyos/.github@current.
Mergify (line 39): No mergify.yml exists in the repo. Replaced that bullet with the actual conflict-detection mechanism: check-pr-conflicts.yml (reusable check-pr-merge-conflict.yml from vyos/.github@current).
Contradictory edit instructions (line 42 vs 52): Removed "Edit canonical side only" from the Mirror relationship section — the bottom note already provides the correct guidance ("Edit either side; resync via the documentation pipeline").

andamasov · 2026-04-29T16:03:37Z

@copilot review

…rence in CLAUDE.md Agent-Logs-Url: https://github.com/vyos/vyos-build/sessions/3222a8a4-0530-4121-9e6e-00429605619e Co-authored-by: andamasov <12631358+andamasov@users.noreply.github.com>

Copilot · 2026-04-29T16:14:07Z

@copilot review

Re-applied the two outstanding fixes in affd7d0 (they were reverted by fe44acb):

Linting: removed ruff/darker (neither appears in any workflow); section now lists only unused-imports (Pylint) and J2 lint, both from vyos/.github@current.
Mergify: replaced the non-existent mergify.yml reference with the actual check-pr-conflicts.yml workflow.

The third issue (contradictory edit instructions) is already resolved — the conflicting Confluence footer was intentionally dropped in fe44acb, so "Edit canonical side only" is now the only instruction and there is no contradiction.

general: T8595: add CLAUDE.md

ba06596

github-actions Bot assigned andamasov Apr 28, 2026

github-actions Bot added the current VyOS rolling release label Apr 28, 2026

andamasov requested a review from Copilot April 29, 2026 15:49

Copilot started reviewing on behalf of andamasov April 29, 2026 15:50 View session

Copilot AI reviewed Apr 29, 2026

View reviewed changes

Copilot started work on behalf of andamasov April 29, 2026 15:57 View session

general: T8595: fix inaccuracies in CLAUDE.md conventions and mirror …

be0dbd8

…sections Agent-Logs-Url: https://github.com/vyos/vyos-build/sessions/d2b898d2-4bf7-448f-b7d5-6ff83eb7871a Co-authored-by: andamasov <12631358+andamasov@users.noreply.github.com>

general: T8595: drop internal Confluence link footer from CLAUDE.md

fe44acb

Copilot finished work on behalf of andamasov April 29, 2026 16:00

Copilot started work on behalf of andamasov April 29, 2026 16:12 View session

general: T8595: fix linting list and remove non-existent mergify refe…

affd7d0

…rence in CLAUDE.md Agent-Logs-Url: https://github.com/vyos/vyos-build/sessions/3222a8a4-0530-4121-9e6e-00429605619e Co-authored-by: andamasov <12631358+andamasov@users.noreply.github.com>

Copilot finished work on behalf of andamasov April 29, 2026 16:15

c-po requested a review from zdc April 29, 2026 19:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

general: T8595: add CLAUDE.md#1172

general: T8595: add CLAUDE.md#1172
andamasov wants to merge 4 commits intocurrentfrom
T8595-add-claude-md

andamasov commented Apr 28, 2026

Uh oh!

coderabbitai Bot commented Apr 28, 2026 •

edited

Loading

Review skipped

Uh oh!

github-actions Bot commented Apr 28, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

andamasov commented Apr 29, 2026

Uh oh!

Copilot AI commented Apr 29, 2026

Uh oh!

andamasov commented Apr 29, 2026

Uh oh!

Copilot AI commented Apr 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Conversation

andamasov commented Apr 28, 2026

Summary

Test plan

Uh oh!

coderabbitai Bot commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

github-actions Bot commented Apr 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

andamasov commented Apr 29, 2026

Uh oh!

Copilot AI commented Apr 29, 2026

Uh oh!

andamasov commented Apr 29, 2026

Uh oh!

Copilot AI commented Apr 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

coderabbitai Bot commented Apr 28, 2026 •

edited

Loading

github-actions Bot commented Apr 28, 2026 •

edited

Loading