GitHub Action
SQAaaS source code assessment
This action triggers the quality assessment of a source code repository.
The inputs below are optional as by default this action will take the current repository and branch.
The URL of the repository to assess.
The branch to fetch from the previous repository name. If a branch is not provided, the SQAaaS platform takes the default one.
Space-separated list of step identifiers (defined with the sqaaas-step-action) that take part in the assessment of the unit testing quality criterion.
JSON payload containing the full QA report.
In most cases, one would use the action in order to run the SQAaaS quality assessment for the repository and branch that triggered the action. To this end, you just need to use the action as follows:
uses: eosc-synergy/sqaaas-assessment-action@v2
However, if required, the action can be used to assess alternative combinations of repositories and branches. Here, you
would need to use the optional inputs repo
and branch
, such as in:
uses: eosc-synergy/sqaaas-assessment-action@v2
with:
repo: 'https://github.com/eosc-synergy/sqaaas-assessment-action'
branch: 'main'
If you want to add a customised step made through the sqaaas-step-action use:
uses: eosc-synergy/sqaaas-assessment-action@v2
with:
qc_uni_steps: tox_unit_step
For this latter case the definiton for the customised step could be similar to (note that step's name
has to match the value of qc_uni_steps
):
uses: eosc-synergy/sqaaas-step-action@v1
with:
name: tox_unit_step
tool: tox
tox_env: run_unit
This action provides a summary of the SQAaaS assessment report, as well as the link to the complete version of it:
A status badge can be used when using this action that will be dynamically updated according to the progress of the quality assessment performed by the SQAaaS platform.
The following markdown excerpt shall be modified by adding your repository name (represented as <repository-name>):
[![SQAaaS badge shields.io](https://github.com/EOSC-synergy/<repository-name>.assess.sqaaas/raw/<branch-name>/.badge/status_shields.svg)](https://sqaaas.eosc-synergy.eu/#/full-assessment/report/https://raw.githubusercontent.com/eosc-synergy/<your-repository-name>.assess.sqaaas/<branch-name>/.report/assessment_output.json)
so e.g.:
[![SQAaaS badge shields.io](https://github.com/EOSC-synergy/sqaaas-assessment-action.assess.sqaaas/raw/main/.badge/status_shields.svg)](https://sqaaas.eosc-synergy.eu/#/full-assessment/report/https://raw.githubusercontent.com/eosc-synergy/sqaaas-assessment-action.assess.sqaaas/main/.report/assessment_output.json)
Note: as the SQAaaS status badges are stored in GitHub repositories, they are not immediately refreshed upon changes in the progress of the quality assessment (GitHub currently sets a Cache-Control
of 300 seconds).