Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@

This action creates a `sdv-manifest.toml` file as a release asset, containing information required for the [SDV Maturity assessment](https://gitlab.eclipse.org/eclipse-wg/sdv-wg/sdv-technical-alignment/sdv-technical-topics/sdv-process/sdv-process-evaluation/-/blob/main/README.md) program. It takes as inputs a set of documents provided by the project, and formats it in a way that Eclipse SDV automation scripts can use to compute the level of maturity of the project according to the criteria defined in the program.

## Criteria

The various criteria, and the expected inputs to the GitHub action parameters, are defined and documented in the [SDV Process definition repository](https://gitlab.eclipse.org/eclipse-wg/sdv-wg/sdv-technical-alignment/sdv-technical-topics/sdv-process/sdv-process-definition/-/tree/main/SDV_Process?ref_type=heads).

## Usage

Expand All @@ -11,7 +14,7 @@ To use this action, one simply needs to add the following steps in their release
```yaml
# Call the quevee gh action to create the manifest file for SDV maturity assessment.
- name: Collect quality artifacts
uses: eclipse-dash/quevee
uses: eclipse-dash/quevee@v1
id: quevee
with:
release_url: ${{ steps.create_release.outputs.url }}
Expand All @@ -37,6 +40,8 @@ If one needs to provide several files for a given criterion, there are two optio
* provide a comma-separated list of files, as shown for the artifacts_testing example above, or
* provide an archive, with a separate github action step.

If the requested artefact is not available, e.g. if the requirements tracing is not ready yet, the entry can be left empty.

An example of a step archiving artifacts can be:
```yaml
- name: Gather Testing documents
Expand Down