Skip to content

Add versioned project assessment report and supporting analysis artifacts#21

Draft
Copilot wants to merge 7 commits into
app-modernize-20260521060831from
copilot/assess-application
Draft

Add versioned project assessment report and supporting analysis artifacts#21
Copilot wants to merge 7 commits into
app-modernize-20260521060831from
copilot/assess-application

Conversation

Copy link
Copy Markdown

Copilot AI commented May 21, 2026

This updates the repository with a complete versioned assessment output under .github/modernize/assessment/reports/, including the generated report payload, rendered report files, and supplemental analysis documents. It also cleans up setup-only skill/context files so the PR contains only the intended assessment deliverables and required deletions.

  • Versioned assessment report

    • Added report.json to .github/modernize/assessment/reports/report-20260521061104/
    • Generated rendered outputs:
      • report.md
      • report.html
  • Supplementary facts package

    • Copied the generated supporting documents into report-20260521061104/facts/:
      • architecture-diagram.md
      • dependency-map.md
      • api-service-contracts.md
      • data-architecture.md
      • configuration-inventory.md
      • business-workflows.md
    • Added assessment-overview.md as the entry point for navigating the fact set
  • Assessment content coverage

    • Captured the application’s:
      • runtime/component architecture
      • external dependency map
      • API surface and communication patterns
      • persistence/data model
      • configuration sources and secrets handling
      • core business workflows
  • Report rendering adjustments

    • Rendered the versioned report from the generated assessment payload and fact files
    • Applied a small HTML wording/formatting correction in the generated report output so the explanation content renders cleanly
  • Required cleanup

    • Removed setup-only .github/skills content from the PR
    • Removed .github/modernize/ccacontext per the task requirements
    • Kept the staged scope centered on .github/modernize/assessment/reports/ plus the intentional deletions

Example of the added report navigation structure:

.github/modernize/assessment/reports/report-20260521061104/
├── report.json
├── report.md
├── report.html
└── facts/
    ├── assessment-overview.md
    ├── architecture-diagram.md
    ├── dependency-map.md
    ├── api-service-contracts.md
    ├── data-architecture.md
    ├── configuration-inventory.md
    └── business-workflows.md
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 and others added 5 commits May 21, 2026 06:18
Agent-Logs-Url: https://github.com/qianwens/PhotoAlbum-Java/sessions/82480c71-f7c9-403f-bbf2-d2fbf546a091

Co-authored-by: qianwens <37290631+qianwens@users.noreply.github.com>
Agent-Logs-Url: https://github.com/qianwens/PhotoAlbum-Java/sessions/82480c71-f7c9-403f-bbf2-d2fbf546a091

Co-authored-by: qianwens <37290631+qianwens@users.noreply.github.com>
Agent-Logs-Url: https://github.com/qianwens/PhotoAlbum-Java/sessions/82480c71-f7c9-403f-bbf2-d2fbf546a091

Co-authored-by: qianwens <37290631+qianwens@users.noreply.github.com>
Copilot AI changed the title [WIP] Run core assessment and analyze application architecture Add versioned project assessment report and supporting analysis artifacts May 21, 2026
Copilot AI requested a review from qianwens May 21, 2026 06:23
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