# jinalsmistry/dhf-release-demo architecture

> Architecture diagram of the GitHub repository jinalsmistry/dhf-release-demo, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jinalsmistry/dhf-release-demo
- Repository: https://github.com/jinalsmistry/dhf-release-demo

## Overview

This POC automates compliance-report creation and describes archiving DHF verification artifacts for permanent retention on GitHub Releases. Its visible report-generation steps consume JUnit XML or a CycloneDX-style BOM and produce Word or Excel reports. The README documents the release-archive goal, but the workflow source was not sampled, so its detailed triggers and artifact-selection behavior are not shown.

Main entry points: [`generate_report.py`](https://github.com/jinalsmistry/dhf-release-demo/blob/main/generate_report.py) (Test report generator), [`generate_sbom_report.py`](https://github.com/jinalsmistry/dhf-release-demo/blob/main/generate_sbom_report.py) (SBOM report generator), [`.github/workflows/compliance-archive.yml`](https://github.com/jinalsmistry/dhf-release-demo/blob/main/.github/workflows/compliance-archive.yml) (Archive workflow)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_reports["Report Generation"]
  node_junit["JUnit XML"]
  node_test_report["Test report"]
  node_report_generator["Test report generator<br/>[generate_report.py]"]
  node_bom["SBOM JSON"]
  node_sbom_report["SBOM report"]
  node_sbom_generator["SBOM report generator"]
end

subgraph group_archive["Release Archiving"]
  node_archive_workflow["Archive workflow"]
  node_github_releases[("GitHub Releases")]
end

node_pipeline(("Automated pipeline"))

node_junit -->|"reads"| node_report_generator
node_report_generator -->|"writes"| node_test_report
node_bom -->|"reads"| node_sbom_generator
node_sbom_generator -->|"writes"| node_sbom_report
node_pipeline -.->|"triggers"| node_archive_workflow
node_archive_workflow -->|"archives artifacts"| node_github_releases

click node_report_generator "https://github.com/jinalsmistry/dhf-release-demo/blob/main/generate_report.py"
click node_sbom_generator "https://github.com/jinalsmistry/dhf-release-demo/blob/main/generate_sbom_report.py"
click node_archive_workflow "https://github.com/jinalsmistry/dhf-release-demo/blob/main/.github/workflows/compliance-archive.yml"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_junit,node_test_report,node_report_generator,node_bom,node_sbom_report,node_sbom_generator toneBlue
class node_archive_workflow,node_github_releases toneAmber
class node_pipeline toneIndigo
```

## Components

### Report Generation

- **JUnit XML**
- **Test report**
- [Test report generator](https://github.com/jinalsmistry/dhf-release-demo/blob/main/generate_report.py): `generate_report.py`
- **SBOM JSON**
- **SBOM report**
- [SBOM report generator](https://github.com/jinalsmistry/dhf-release-demo/blob/main/generate_sbom_report.py): `generate_sbom_report.py`

### Release Archiving

- [Archive workflow](https://github.com/jinalsmistry/dhf-release-demo/blob/main/.github/workflows/compliance-archive.yml): `.github/workflows/compliance-archive.yml`
- **GitHub Releases**

### Other components

- **Automated pipeline**

## Connections

- JUnit XML → Test report generator: reads (evidence: `generate_report.py`)
- Test report generator → Test report: writes (evidence: `generate_report.py`)
- SBOM JSON → SBOM report generator: reads (evidence: `generate_sbom_report.py`)
- SBOM report generator → SBOM report: writes (evidence: `generate_sbom_report.py`)
- Automated pipeline → Archive workflow: triggers
- Archive workflow → GitHub Releases: archives artifacts (evidence: `README.md`)
