Skip to content

Add nightly quality workflow with GitHub Pages dashboard#393

Draft
ahmed0mousa wants to merge 1 commit intoeclipse-score:mainfrom
ahmed0mousa:ahmo_quality_managment_proposal
Draft

Add nightly quality workflow with GitHub Pages dashboard#393
ahmed0mousa wants to merge 1 commit intoeclipse-score:mainfrom
ahmed0mousa:ahmo_quality_managment_proposal

Conversation

@ahmed0mousa
Copy link
Copy Markdown
Contributor

No description provided.

Comment on lines +14 to +17
3. `deploy_dashboard` job runs after all others
4. `generate_dashboard.py` produces a single-page HTML dashboard with job statuses
5. Coverage HTML report is included as a sub-page
6. Result is deployed to GitHub Pages
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

include it into the existing sphinx build in //docs/sphinx

Comment on lines +26 to +29

- **$0** — GitHub Actions provides unlimited minutes for public repos; GitHub Pages is free for public repos (100 GB bandwidth/month, 1 GB storage)

### Pros
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don´t know if this is true for organistations

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You maybe mean private repos but for public repos its free

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This document is only describing different ways of creating a dashboard.

For me at first a quality.md should be created which describes how do run quality tools like:

  1. How to setup unit tests
  2. How to setup integration tests
  3. How to run all tests (platform qnx ...)
  4. How to measure code coverage for tests
  5. How to run static code analysis
  6. How to run clang tidy maybe?

Based on this we can then derive which metrics need to be displayed on the dashboard.

For the Dashboard we have already an existing sphinx build on read the docs where we could integrate our dashboard: https://score-communication.readthedocs.io/en/latest/

For the report then maybe start with passed/failed tests, continue with coverage and then maybe static code analysis.

Since we already have a sphinx build it maybe would be beneficial if we could get the results as rst files then we could directly include them into our build

Copy link
Copy Markdown
Contributor Author

@ahmed0mousa ahmed0mousa May 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is not the quality.md, the quality.md is done by Ambuj in different PR https://cc-github.bmwgroup.net/oss/eclipse-score-communication/pull/215

this doc is only for how we can see/manage the quality KPIs on Score

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