Skip to content

Fine-tune the Community reports - #110

Merged
bencehezso merged 1 commit into
release/2.0from
task/report_fine_tuning
Oct 25, 2026
Merged

bencehezso merged 1 commit into
release/2.0from
task/report_fine_tuning

Conversation

@bencehezso

Copy link
Copy Markdown
Contributor

Summary

Corrections to the Community reports. The Executive Summary PDF no longer ends with a promotional closing page. A missing vendor shows "–". The icon notices no longer repeat link text. A failed upload and the resources a Terraform state run left out are now stated.

Changes

Executive Summary PDF

  • Removed the "What the Full Assessment Adds" and "The Full Assessment" pages, the fa_* wording, full_assessment and the HOST command. Nothing replaces them.
  • The platform link stays on page 2 (Provenance). An upload without a link now shows the assessment ID there.
  • A missing vendor in the alternatives prints "Name · –", as the HTML does.

Notices

  • notices_icons_aws and notices_icons_azure use the name as the link field; the html_label_* icon keys are gone.
  • HTML: one link per name, no brackets. PDF: "label (address)" with the address linked, so the printed text is unchanged.

Failed upload

  • spooled is added to REPORT_KEYS.
  • Page 2 of both PDFs and About This Report read "Upload failed: {reason}.", plus " The run was kept for a later upload." when the run was spooled, or "Upload failed." without a reason. The HTML chip stays "Self-collected".

Terraform state coverage

  • _load_tfstate_scope also returns coverage; older manifests without it render as before.
  • When instances were excluded, Assessment Scope (page 2 and About This Report) gets a "Not Assessed" row ("{n} resources of other providers, {m} resources of types not in the data catalogue", non-zero parts only).
  • The Resource Inventory caption adds "{n + m} resources in the state file were not assessed (see page 2)" ("see About This Report" in the HTML).

Sample matrix (developer tooling)

  • 12 → 17 cases: upload_failed, egress_unsized, empty_with_costs, legacy_catalogue, tfstate_skipped (new sample_aws_skipped.tfstate fixture).
  • The loader accepts spooled, reason and catalogue, with errors naming the file and field. azure_uploaded purpose text updated. EXPECTED_FILES unchanged.

Tests

  • The closing-page tests are replaced with outline, no-promotion (including the "Enterprise support" flag not tripping the "Enterprise" check), missing-vendor, notice-link, failed-upload, coverage and sample checks.

Sample render (before vs after)

  • The 12 existing cases change only in report.txt and index-html.txt; egress.txt is unchanged everywhere.
  • Executive Summary PDF: one page shorter, plus the "–" vendor.
  • HTML: the icon notice links, plus the new Terraform state caption and row on the two existing state cases.
  • 5 new cases rendered.

Compatibility

  • Config, flags, exit codes, the dataset, the sync document and the docs/api-v2/ copy: unchanged.
  • Report output: the Executive Summary PDF loses its closing page and is one page shorter; a missing vendor shows "–"; the HTML icon notices link the names without brackets; a failed upload and a Terraform state run's excluded resources are stated.
  • Developer tooling: the sample matrix grows from 12 to 17 cases.

@bencehezso bencehezso self-assigned this Oct 25, 2026
@bencehezso bencehezso added the enhancement New feature or request label Oct 25, 2026
@bencehezso
bencehezso merged commit 1304b88 into release/2.0 Oct 25, 2026
11 checks passed
@bencehezso
bencehezso deleted the task/report_fine_tuning branch October 25, 2026 17:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant