🛠️ Project Reporting Artifacts

This repository stores generated reports and data artifacts from the Project Reporting Tool. A daily GitHub Actions workflow in the tool repository generates these reports and copies them here for long-term storage and historical archival.

Note: The workflow generates reports automatically every day at 7:00 AM UTC. Published reports are available at the GitHub Pages site.

Repository Structure

The data/artifacts/ directory contains all report artifacts, organized by date:

data/artifacts/
└── YYYY-MM-DD/
    ├── README.md                     # Summary of that day's run
    ├── reports-<slug>/               # Generated reports
    │   ├── report.html               # Interactive HTML report
    │   ├── report.md                 # Markdown report
    │   ├── report_raw.json           # Complete raw data
    │   ├── config_resolved.json      # Applied configuration
    │   ├── metadata.json             # Generation metadata
    │   ├── theme.css                 # Report styling
    │   └── <PROJECT>_report_bundle.zip
    ├── raw-data-<slug>/              # Raw JSON data files
    │   ├── report_raw.json
    │   ├── config_resolved.json
    │   └── metadata.json
    └── clone-manifest-<slug>/        # Repository clone manifests
        └── clone-manifest.json

This structure preserves a complete history of daily report runs for all configured Linux Foundation projects.

Viewing Reports

For the latest published reports, visit the GitHub Pages site hosted by the project-reporting-tool repository.

To browse historical data stored here:

1. GitHub web interface — Navigate the data/artifacts/YYYY-MM-DD/ directories to find reports from a specific date
2. Clone locally — Clone this repository and open HTML files in a browser

Report Contents

Each report includes comprehensive analytics such as:

• Repository statistics and metrics
• Commit activity and contributor information
• INFO.yaml project metadata and committer tracking
• Jenkins job allocation and CI/CD workflow status
• Feature detection (documentation, security tools, dependency management)
• Historical trends and analysis

How the Workflow Generates Reports

The Project Reporting Tool runs a production workflow daily:

1. The workflow clones all repositories from each configured Gerrit server
2. For each project, it analyzes repositories and generates reports in JSON, Markdown, and HTML formats
3. The workflow uploads reports as artifacts
4. A final job copies all artifacts to this repository, organized by date

For details on report generation, see the tool documentation.

Contributing

This repository is automatically maintained. Later workflow runs will overwrite any manual changes.

To make changes:

• Add a new project — Update the PROJECTS_JSON secret in the tool repository
• Change report generation — Update the Python code or templates in the tool repository
• Report issues — Open an issue in the tool repository issues

License

The Apache License 2.0 covers all content — see the LICENSE file for details.