Skip to content

[AAASM-4193] 📝 (docs): Complete the deploy.yml→aggregate.yml rename across all files#58

Open
Chisanan232 wants to merge 4 commits into
mainfrom
v0.0.1/AAASM-4193/complete_aggregate_yml_rename
Open

[AAASM-4193] 📝 (docs): Complete the deploy.yml→aggregate.yml rename across all files#58
Chisanan232 wants to merge 4 commits into
mainfrom
v0.0.1/AAASM-4193/complete_aggregate_yml_rename

Conversation

@Chisanan232

Copy link
Copy Markdown
Contributor

Description

Completes the deploy.ymlaggregate.yml workflow rename across the repo. The workflow was renamed (only aggregate.yml exists in .github/workflows/; deploy.yml is deleted), but AAASM-4174 fixed the README only — the sibling docs still pointed at the deleted file, producing 404 links on GitHub and wrong agent guidance. This is the same missed-sibling / incomplete-class-fix pattern.

Doc/text change only — no code behavior changes.

Type of Change

  • 🐛 Bug fix (correcting inaccurate or missing content)

Related Issues

  • Related Jira ticket: AAASM-4193
  • Incomplete class-fix of: AAASM-4174

What changed

Full grep-sweep (grep -rn 'deploy\.yml' . --exclude-dir=.git --exclude-dir=book).

Before (13 hits) → fixed (11):

File:line Kind Action
CONTRIBUTING.md:5 404 link aggregate.yml
CONTRIBUTING.md:38 dir-tree comment aggregate.yml
docs/sync-architecture.md:24 mermaid node aggregate.yml
docs/sync-architecture.md:35 404 link aggregate.yml
docs/sync-architecture.md:97 mermaid label aggregate.yml
docs/sync-architecture.md:107 404 link aggregate.yml
docs/sync-architecture.md:168 404 link aggregate.yml
.claude/CLAUDE.md:6 source-of-truth workflow name aggregate.yml
.claude/CLAUDE.md:91-92 CI path-scope description rewritten (see below)
docs/theme/light-dark-toggle.js:12 live "CI deploys today" pointer aggregate.yml + version

CLAUDE.md trigger description — verified, not guessed. aggregate.yml has no paths: filter; it triggers on push/pull_request to main plus workflow_dispatch. The old gotcha claimed "CI is path-scoped … a .claude/-only change runs no CI" — now false. Rewrote it to state every push/PR to main runs the full workflow.

light-dark-toggle.js: the comment was a live pointer ("CI deploys 0.4.x today") — aggregate.yml pins mdBook 0.5.2, so both the filename and the stale 0.4.x/0.5.x CI-vs-local note were corrected to match reality.

Intentionally left (2) — historical/legacy references; renaming would make them factually false:

File:line Text Why left
AGGREGATION.md:149 "the legacy deploy.yml, no aggregation" Deliberate historical contrast with the current aggregation model; "legacy aggregate.yml, no aggregation" would be self-contradictory.
.github/workflows/aggregate.yml:42 "the older 0.4.x in deploy.yml cannot render it" Explains why aggregate.yml uses mdBook 0.5.2 vs the old workflow's 0.4.x; renaming would falsely claim aggregate.yml itself runs 0.4.x.

Both are docs/book/ build-output duplicates aside — that dir is .gitignored and not committed.

How to verify

  • cd docs && mdbook build — passes (only the benign mdbook-mermaid 0.5.0-vs-0.5.2 build-version warning).
  • grep -rn 'deploy\.yml' . --exclude-dir=.git --exclude-dir=book — only the 2 intentional historical refs above remain; every live docs-workflow reference now points at aggregate.yml, and .github/workflows/aggregate.yml exists so the links resolve.

Documentation Checklist

  • cd docs && mdbook build passes locally (benign mermaid version warning only)
  • All internal cross-links verified (repointed links target the existing aggregate.yml)
  • Commits follow GitEmoji convention and are small / atomic (one per file)

Follow-ups (out of scope for this rename)

  • No mdbook-linkcheck gate. The QA sweep noted broken relative links pass CI silently. Adding a linkcheck backend to docs/book.toml (or a lychee CI step) is a separate change — flagging as a follow-up, not done here.
  • Pre-existing version drift unrelated to the rename: CONTRIBUTING.md:18 and docs/sync-architecture.md:36 still say CI pins mdBook v0.4.40, but aggregate.yml installs 0.5.2. No deploy.yml token involved; left untouched to keep this PR scoped.

🤖 Generated with Claude Code

https://claude.ai/code/session_01R7vqjjo5nrebYNt8WnCNbz

Chisanan232 and others added 4 commits July 6, 2026 13:00
Complete the deploy.yml→aggregate.yml rename (incomplete fix of
AAASM-4174): repoint the 404ing workflow link and the dir-tree comment
to the actual aggregate.yml workflow.

Refs AAASM-4193
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01R7vqjjo5nrebYNt8WnCNbz
Repoint the two mermaid nodes and three 404ing links describing the
current build+deploy workflow to aggregate.yml.

Refs AAASM-4193
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01R7vqjjo5nrebYNt8WnCNbz
…te.yml

Repoint the source-of-truth workflow name to aggregate.yml and rewrite
the stale 'CI is path-scoped' gotcha: aggregate.yml has no path filter,
so every push/PR to main (plus workflow_dispatch) runs the full
workflow — a .claude/-only change is now CI-gated, not review-only.

Refs AAASM-4193
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01R7vqjjo5nrebYNt8WnCNbz
… 0.5.x

The live 'CI deploys today' pointer referenced the deleted deploy.yml
and the old 0.4.x version; aggregate.yml pins mdBook 0.5.2, so update
both the filename and the CI/local version note to match reality.

Refs AAASM-4193
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01R7vqjjo5nrebYNt8WnCNbz
@sonarqubecloud

sonarqubecloud Bot commented Jul 6, 2026

Copy link
Copy Markdown

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