openMSL / sl-1-0-sensor-model-repository-template

Template repository: Clone and build your ASAM OSI sensor model.

Mozilla Public License 2.0

8 stars 2 forks source link

Workflow Badges #51

Closed ClemensLinnhoff closed 1 year ago

ClemensLinnhoff commented 1 year ago

Reference to a related issue in the repository

50

Add a description Since all Credibility Assessment Levels are now integrated into one workflow, only one badge can be displayed in the readme.

Take this checklist as orientation for yourself, if this PR is ready for Maintainer Review

[x] My suggestion follows the governance rules.
[x] All commits of this PR are signed.
[x] My changes generate no errors when passing CI tests.
[x] I updated all documentation (readmes incl. figures) according to my changes.
[x] I have successfully implemented and tested my fix/feature locally.
[x] Appropriate reviewer(s) are assigned.

ClemensLinnhoff commented 1 year ago

Is the rather generic term "Test Pipeline" okay for the workflow/badge? An alternative would be to name it "Credibility Assessment".

Which level is passed has to be determined by looking into the pipeline. Or should we put the highest achieved credibility level next to the badge?

jdsika commented 1 year ago

I am in favor of showing a single batch and rate a well structured workflow file over multiple batches

jdsika commented 1 year ago

"Credibility assessment" sounds good also in combination with the level! Can we make a warning+hint if it partly failed?

ClemensLinnhoff commented 1 year ago

"Credibility assessment" sounds good also in combination with the level! Can we make a warning+hint if it partly failed?

If it partly fails, it will show the badge as failed. You can then go into the action and see which parts failed. However, since you can only merge into main, when the pipeline passes, this is a rather theoretical issue. The badge will probably never show "failed" in the main readme, as it is not possible to merge into main with a failing workflow.