Skip to content

Generate versioned assessment report with architecture fact pack#22

Draft
Copilot wants to merge 4 commits into
app-modernize-20260521063155from
copilot/run-assessment-and-generate-docs
Draft

Generate versioned assessment report with architecture fact pack#22
Copilot wants to merge 4 commits into
app-modernize-20260521063155from
copilot/run-assessment-and-generate-docs

Conversation

Copy link
Copy Markdown

Copilot AI commented May 21, 2026

This PR completes the assessment workflow by producing a versioned AppCAT report, generating the required architecture/dependency/API/data/config/workflow fact documents, and rendering final human-readable report outputs (report.html, report.md) under the same versioned report directory.

  • Assessment output versioning

    • Moved AppCAT output into:
      • .github/modernize/assessment/reports/report-20260521063406/report.json
  • Supplementary analysis documents (facts/)

    • Added the required files under:
      • .github/modernize/assessment/reports/report-20260521063406/facts/
    • Included:
      • architecture-diagram.md
      • dependency-map.md
      • api-service-contracts.md
      • data-architecture.md
      • configuration-inventory.md
      • business-workflows.md
  • Facts navigation entrypoint

    • Added assessment-overview.md in facts/ as an index of copied supplementary docs with short descriptions and links.
  • Rendered report artifacts

    • Generated:
      • .github/modernize/assessment/reports/report-20260521063406/report.html
      • .github/modernize/assessment/reports/report-20260521063406/report.md
  • Repository cleanup aligned to task requirements

    • Included intentional setup-file removals (.github/skills/** and .github/modernize/ccacontext/**) per issue instructions.
    • Kept report content scoped to .github/modernize/assessment/reports/ for staged assessment deliverables.

Example of the new facts index structure:

# Assessment Overview

- [architecture-diagram.md](./architecture-diagram.md) — High-level and component-level architecture diagrams.
- [dependency-map.md](./dependency-map.md) — External dependency inventory and compatibility observations.
- [api-service-contracts.md](./api-service-contracts.md) — Service catalog, endpoint contracts, and communication sequence.
- [data-architecture.md](./data-architecture.md) — Persistence model and data classification notes.
- [configuration-inventory.md](./configuration-inventory.md) — Config sources, profiles, and secrets workflow.
- [business-workflows.md](./business-workflows.md) — Core business processes and decision logic.
Original prompt

Task: Assess the application

Run core assessment

Use the 'assessment' skill to analyze the application and generate the assessment report.
This skill runs AppCAT (Azure Migrate application and code assessment) to detect migration issues.

Architecture analysis

Use the 'architecture-diagram' skill to generate the architecture diagram.
Use the 'dependency-map' skill to generate the dependency map.
Use the 'api-service-contracts' skill to generate the API and service communication contracts.
Use the 'data-architecture' skill to generate the data architecture documentation.
Use the 'configuration-inventory' skill to generate the configuration inventory.
Use the 'business-workflows' skill to generate the business workflow documentation.

For Java or .NET project, copy the architecture-diagram.md, dependency-map.md, api-service-contracts.md, data-architecture.md, configuration-inventory.md, and business-workflows.md under the {{ASSESSMENT_OUTPUT_PATH}}/engines directory into a facts/ subdirectory of the versioned report directory, that is, {{ASSESSMENT_OUTPUT_PATH}}/reports/report-{reportId}/facts/.

After copying, generate an assessment-overview.md in that same facts directory ({{ASSESSMENT_OUTPUT_PATH}}/reports/report-{reportId}/facts/). This file should be a navigation entry point that lists all the supplementary documents that were successfully copied, with links and brief descriptions. Only include documents that actually exist in the directory.

Report generation

After all assessment skills have completed and the report data is available, generate human-readable report files:

  1. Use the 'generate-report-html' skill to generate report.html in the versioned report directory (.github/modernize/assessment/reports/report-{reportId}/).
  2. Use the 'generate-report-md' skill to generate report.md in the same versioned report directory.

These skills include Python scripts that read the existing report.json (or js-assessment-report.md for JavaScript/TypeScript projects) and the facts/ subdirectory to produce the rendered reports. Run them only AFTER all other skills listed above have fully completed (or were not applicable and therefore skipped) — the report data and fact files must all be written before generating the reports.

Commit and PR instructions

ONLY stage files under .github/modernize/assessment/reports/ (the versioned report directory):

git add -f .github/modernize/assessment/reports

For JavaScript/TypeScript projects, also run:

git add -f .github/modernize/assessment/js-assessment-report.md

Then remove any files that were added by previous setup commits and should NOT appear in the PR:

git rm -rf .github/skills .github/modernize/ccacontext 2>/dev/null || true
git reset HEAD -- .github/modernize/assessment/engines .github/modernize/appcat .github/modernize/appmod .github/copilot 2>/dev/null || true

IMPORTANT: The .github/skills deletions are INTENTIONAL — these files were added in a setup commit before your session started and MUST be removed from the PR. Do NOT revert, restore, or undo these deletions. The final staged state should show .github/skills files as D (deleted) — this is correct and expected.

Do NOT run git add ., git add -A, or git add on any broad paths like .github/modernize. Only the versioned report directory under reports/ should be committed.

When creating the PR, propose a proper title, but DO NOT contain any tool/tech stack on it, e.g. 'Assessing project with AppCAT' is not good as AppCAT is one of the assessing tool.


After the job is complete, clean the context by following the steps below silently, without any output to the execution summary:

  • Running the cleanup script will remove the skills and context files added for this job from the repository.
.github/modernize/ccacontext/cleanup.sh
  • Remove the ccacontext folder .github/modernize/ccacontext from the repository as it's no longer needed.
  • Make sure the changes in the folder '.github/modernize' and its subfolders are force committed

This pull request contains changes made by the Modernization Cloud Agent.

Copilot AI changed the title [WIP] Run core assessment and generate architecture documentation Generate versioned assessment report with architecture fact pack May 21, 2026
Copilot AI requested a review from qianwens May 21, 2026 06:41
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.

2 participants