Skip to content

GHCP -- Walk: Ex1 Repo Orientation and Architecture Map - #3576

Closed
neha-p6 wants to merge 1 commit into
learn/crawl/neha-p6-ex15from
learn/walk/neha-p6-ex1
Closed

GHCP -- Walk: Ex1 Repo Orientation and Architecture Map#3576
neha-p6 wants to merge 1 commit into
learn/crawl/neha-p6-ex15from
learn/walk/neha-p6-ex1

Conversation

@neha-p6

@neha-p6 neha-p6 commented May 21, 2026

Copy link
Copy Markdown

Summary

  • Updated ai-track-docs/architecture.mmd from a placeholder to a fully mapped diagram: every node now includes its real repo path (components/main-chef-wrapper/main.go, cmd/root.go, commands/automate_config.go, etc.)
  • Added three annotated flows: dependency flow (imports/registers), invocation flow (user entry points), and two data flows (CLI passthrough → Chef Infra Server; telemetry trigger → Automate HTTP POST via TLS)
  • Added scripts/validate-diagram.sh: tries mmdc if installed, falls back to 6 grep-based syntax checks; exits non-zero on failure
  • Added .github/workflows/validate-diagram.yml: installs @mermaid-js/mermaid-cli and runs the script on every PR that touches ai-track-docs/
  • Plan: Inline above – map nodes → paths first, layer flows second, add CI validation last

Files/paths touched

  • ai-track-docs/architecture.mmd
  • scripts/validate-diagram.sh
  • .github/workflows/validate-diagram.yml

Evidence

$ bash scripts/validate-diagram.sh
==> Validating .../ai-track-docs/architecture.mmd
==> mmdc not found – running lightweight syntax checks
  [PASS] graph directive present
  [PASS] at least one subgraph
  [PASS] at least one node label
  [PASS] at least one dependency arrow
  [PASS] at least one data-flow arrow
  [PASS] file path reference in node
==> Syntax checks PASSED
  • Coverage: doc-only change; no source coverage delta

Risk & Rollback

  • Risk: low (doc + script only, no source code changed)
  • Rollback: git revert feda5260

Review Focus

  • Confirm node labels correctly reflect actual file paths
  • Run bash scripts/validate-diagram.sh locally to confirm green output
  • Check .github/workflows/validate-diagram.yml path-filter triggers as expected

Track

  • Level: Walk
  • Exercise: Ex1

…add diagram CI

Signed-off-by: neha-p6 <neha.pansare@progress.com>
@neha-p6
neha-p6 force-pushed the learn/walk/neha-p6-ex1 branch from feda526 to 380d0c2 Compare May 21, 2026 11:45
@neha-p6
neha-p6 changed the base branch from main to learn/crawl/neha-p6-ex15 May 21, 2026 11:47
@neha-p6 neha-p6 closed this May 21, 2026
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