Skip to content

Add arch plugin (architecture + modernization skills)#2253

Merged
aaronpowell merged 6 commits into
github:mainfrom
samqbush:add-arch-plugin
Jul 10, 2026
Merged

Add arch plugin (architecture + modernization skills)#2253
aaronpowell merged 6 commits into
github:mainfrom
samqbush:add-arch-plugin

Conversation

@samqbush

@samqbush samqbush commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

What this adds

A new curated in-repo plugin, arch, providing a single consolidated skill for working with locally-cloned repositories:

  • doc-and-modernize (surfaces as arch:doc-and-modernize when installed via the plugin) — one skill with two complementary modes:
    • Documentation mode — Produce a single, comprehensive, cited architecture document, local-first: it reads the local checkout by default, cites every claim to a file+line, flags unverified facts, and deep-dives the most complex subsystems. A web/API lookup is a deliberate, clearly-flagged last-resort fallback for a fact that genuinely can't be determined from disk (marked [UNVERIFIED]/sourced-remotely), not the default path. Great for onboarding docs.
    • Modernization mode — Generate a phased modernization plan for a legacy codebase. If an architecture document already exists it builds on it; otherwise it first runs the Documentation-mode workflow inline, then continues to the plan. Produces per-feature migration docs, tech-stack ADRs, and an adaptive, safety-laddered phased plan.

Structure

Following the repo's declarative plugin model, the skill source lives in the top-level skills/ directory and is referenced from plugins/arch/.github/plugin/plugin.json; CI materializes it into the installable plugin. The two workflows were consolidated into one standalone skill (rather than two) because top-level skills/ are published/validated as standalone, so the modes now cross-reference each other inline instead of invoking a separate skill.

  • plugins/arch/.github/plugin/plugin.json + plugins/arch/README.md
  • skills/doc-and-modernize/SKILL.md (+ references/)
  • Regenerated docs/README.plugins.md, docs/README.skills.md, .github/plugin/marketplace.json

Validation

  • npm run skill:validate
  • npm run plugin:validate
  • npm run build (regenerated docs + marketplace) ✅
  • bash eng/fix-line-endings.sh

Add the `arch` plugin with two skills:
- `arch:document` — produce a single, cited architecture document for a
  locally-cloned repo, reading files on disk only.
- `arch:modernize` — generate a phased modernization plan, auto-running the
  document workflow first when no architecture doc exists.

Skill sources live in top-level skills/ and are referenced declaratively
from plugins/arch/.github/plugin/plugin.json, per the repo's plugin model.
Regenerated docs/README.plugins.md, docs/README.skills.md and marketplace.json.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@samqbush samqbush requested a review from aaronpowell as a code owner July 9, 2026 13:52
Copilot AI review requested due to automatic review settings July 9, 2026 13:52
@github-actions github-actions Bot added new-submission PR adds at least one new contribution plugin PR touches plugins skills PR touches skills labels Jul 9, 2026
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

🔒 PR Risk Scan Results

Scanned 8 changed file(s).

Severity Count
🔴 High 0
🟠 Medium 1
ℹ️ Info 0
Severity Rule File Line Match
🟠 package-exec-command docs/README.skills.md 31 | [acreadiness-assess](../skills/acreadiness-assess/SKILL.md)&lt;br /&gt;`gh skills install github/awesome-copilot acreadiness-assess` | Run the AgentRC readiness assessment on the curre

This is an automated soft-gate report. Findings indicate review targets and do not block merge by themselves.

@github-actions github-actions Bot added the skill-check-error Skill validator reported errors label Jul 9, 2026
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

🔍 Vally Lint Results

⛔ Findings need attention

Scope Checked
Skills 1
Agents 0
Total 1
Severity Count
❌ Errors 1
⚠️ Warnings 0
ℹ️ Advisories 0

Summary

Level Finding
doc-and-modernize (1/2 checks passed, 1 failed)
Full linter output
### Linting skills/doc-and-modernize
npm warn EBADENGINE Unsupported engine {
npm warn EBADENGINE   package: 'commander@15.0.0',
npm warn EBADENGINE   required: { node: '>=22.12.0' },
npm warn EBADENGINE   current: { node: 'v20.20.2', npm: '10.8.2' }
npm warn EBADENGINE }
npm warn deprecated prebuild-install@7.1.3: No longer maintained. Please contact the author of the relevant native addon; alternatives are available.
❌ doc-and-modernize (1/2 checks passed, 1 failed)
    ✗ [spec-compliance] 1 of 1 skill(s) have spec violations.
        ✗ spec-compliance: Spec checks failed.
            ✗ File length (851 lines) exceeds limit (500).
    ✓ [valid-refs] All file references across 1 skill(s) are valid.
        ✓ valid-refs: All file references resolve to existing files within the skill directory.

1 skill(s) linted, 1 failed

Note: Vally lint returned a non-zero exit code. Please review the findings above before merge.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Adds a new in-repo plugin, arch, that bundles two new skills to (1) generate a cited architecture document from a local checkout and (2) produce an adaptive, phase-based modernization plan (including supporting reference materials). Updates the generated plugin/skill docs and marketplace index so the new resources are discoverable and installable.

Changes:

  • Added two new skills: document (architecture research) and modernize (modernization planning with safety-ladder framing).
  • Added plugins/arch with plugin manifest + README bundling the two skills.
  • Updated generated documentation (docs/README.*) and .github/plugin/marketplace.json to include the new plugin/skills.
Show a summary per file
File Description
skills/modernize/SKILL.md Defines the modernization planning workflow, phases, and governance model.
skills/modernize/references/migration-hazards.md Adds a reusable hazard catalog (H1–H8) to red-team migration phases.
skills/modernize/references/copilot-instructions.template.md Adds a template for .github/copilot-instructions.md to execute the plan.
skills/document/SKILL.md Defines the local-checkout architecture research workflow and output structure.
plugins/arch/README.md Documents the new arch plugin and its included skills.
plugins/arch/.github/plugin/plugin.json Registers the new arch plugin and bundles the two skills.
docs/README.skills.md Adds entries for the new document and modernize skills.
docs/README.plugins.md Adds the new arch plugin to the plugin index.
.github/plugin/marketplace.json Adds arch to the generated marketplace listing.

Review details

  • Files reviewed: 9/9 changed files
  • Comments generated: 4
  • Review effort level: Low

Comment thread skills/document/SKILL.md Outdated
Comment thread skills/modernize/SKILL.md Outdated
Comment thread skills/modernize/SKILL.md Outdated
Comment thread skills/modernize/references/copilot-instructions.template.md Outdated
Collapse the document and modernize skills into one standalone skill
(doc-and-modernize) with Documentation and Modernization modes, keeping
the plugin named arch. Modernization mode now runs the Documentation
workflow inline instead of invoking a separate arch:document skill,
fixing standalone-install cross-skill references. Reframe Documentation
mode as local-first (remote/API lookups are a flagged last resort)
rather than local-only. Regenerate docs and marketplace.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 9, 2026 14:19

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review details

  • Files reviewed: 8/8 changed files
  • Comments generated: 3
  • Review effort level: Low

Comment thread plugins/arch/README.md Outdated
Comment thread skills/doc-and-modernize/SKILL.md
Comment thread plugins/arch/.github/plugin/plugin.json
Use 'doc-and-modernize' (repo convention) instead of the namespaced
'arch:doc-and-modernize', noting it surfaces as arch:doc-and-modernize
when installed via the plugin.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 9, 2026 14:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review details

  • Files reviewed: 8/8 changed files
  • Comments generated: 1
  • Review effort level: Low

Comment thread skills/doc-and-modernize/references/copilot-instructions.template.md Outdated
Change plain-text <PROJECT NAME> to [PROJECT NAME] in the header and
first paragraph so Markdown renderers don't parse it as an HTML tag and
drop it. The code-span `<N>` on the phase line is unaffected.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 9, 2026 14:37

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review details

  • Files reviewed: 8/8 changed files
  • Comments generated: 4
  • Review effort level: Low

Comment thread skills/doc-and-modernize/SKILL.md Outdated
Comment thread skills/doc-and-modernize/SKILL.md Outdated
Comment thread plugins/arch/README.md Outdated
Comment thread plugins/arch/.github/plugin/plugin.json
- Fix codespell: pre-empts -> preempts in the instructions template
- Consistent terminology: replace 'research step/workflow' with
  'Documentation mode' in SKILL.md, README, and plugin.json description
- Fix run-on: add 'that' before 'Modernization mode must surface'
- Regenerate docs/marketplace for the updated plugin description

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 9, 2026 14:46

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review details

  • Files reviewed: 8/8 changed files
  • Comments generated: 2
  • Review effort level: Low

Comment thread skills/doc-and-modernize/SKILL.md Outdated
Comment thread skills/doc-and-modernize/SKILL.md Outdated
- Instruct redacting credentials/tokens from git remote URLs before recording
- CI enforcement: ask user or mark [UNVERIFIED]; remote lookup is flagged last resort

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 9, 2026 15:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Review details

  • Files reviewed: 8/8 changed files
  • Comments generated: 0 new
  • Review effort level: Low

@aaronpowell aaronpowell merged commit aa99d75 into github:main Jul 10, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new-submission PR adds at least one new contribution plugin PR touches plugins skill-check-error Skill validator reported errors skills PR touches skills

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants