@@ -22,14 +22,15 @@ Usage:
2222 resqui indicators
2323
2424Options:
25- -u <repository_url> URL of the repository to be analyzed.
26- -c <config_file> Path to the configuration file.
27- -o <output_file> Path to the output file [default: resqui_summary.json].
28- -t <github_token> GitHub API token.
29- -b <branch> The Git branch to be checked.
30- -v Verbose output.
31- --version Show the version of the script.
32- --help Show this help message.
25+ -u <repository_url> URL of the repository to be analyzed.
26+ -c <config_file> Path to the configuration file.
27+ -o <output_file> Path to the output file [default: resqui_summary.json].
28+ -t <github_token> GitHub API token.
29+ -d <dashverse_token> DashVerse API token.
30+ -b <branch> The Git branch to be checked.
31+ -v Verbose output.
32+ --version Show the version of the script.
33+ --help Show this help message.
3334```
3435
3536### Configuration file (optional)
@@ -56,7 +57,8 @@ with the content below. It also needs a new **environment** called **resqui** in
5657your GitHub repository settings under
5758` https://github.com/USER_OR_GROUP/PROJECT/settings/environments ` with a secret
5859environment variable named ` DASHVERSE_TOKEN ` which is needed for publishing the
59- pipeline results to the DashVerse instance.
60+ pipeline results to the DashVerse instance. Alternatively, the ` -d <dashverse_token> `
61+ can be used to pass the token to the command line tool.
6062
6163Note: the CI action will be triggered on each "push". Make sure to ** Allow all
6264actions and reusable workflows** in the repository settings under
@@ -104,19 +106,22 @@ When running `resqui` as a GitHub action, the automatically generated token from
104106job will be used.
105107
106108```
107- $ resqui -c example.json -t $RESQUI_GITHUB_TOKEN
109+ $ resqui -c configurations/basic.json -v -t $RESQUI_GITHUB_TOKEN -d $DASHVERSE_TOKEN
110+ Loading configuration from 'configurations/basic.json'.
108111GitHub API token ✔
109112Repository URL: https://github.com/EVERSE-ResearchSoftware/QualityPipelines.git
110113Project name: QualityPipelines
111114Author: Tamas Gal
112115Email: himself@tamasgal.com
113- Version: v0.1.0-95-gc1dacb1
114- Branch, tag or commit hash: c1dacb1197005e9bce20063b2215bdfd7f9939d9
116+ Version: v0.1.6
117+ Branch, tag or commit hash: dea5fe13df68e0f4541c4425823752f4b33f4b7e
115118Checking indicators ...
116- has_license/HowFairIs (1.2s): ✖
117- has_citation/CFFConvert (1.0s): ✖
119+ has_license/HowFairIs (0.9s):
120+ Found license file: 'LICENSE'.✔
121+ has_citation/CFFConvert (0.3s):
122+ Found valid CITATION.cff file in repository root.✔
118123Summary has been written to resqui_summary.json
119- Publishing summary ✔
124+ Publishing summary ✔
120125```
121126
122127### Output File
@@ -127,9 +132,15 @@ The current output format is a `JSON`, based on the Schema presented here: https
127132{
128133 "@context" : " https://w3id.org/everse/rsqa/0.0.1/" ,
129134 "@type" : " SoftwareQualityAssessment" ,
130- "dateCreated" : " 2025-07-16 09:17:34.280112" ,
131- "license" : {
132- "@id" : " https://creativecommons.org/publicdomain/zero/1.0/"
135+ "assessedSoftware" : {
136+ "@type" : " SoftwareApplication" ,
137+ "name" : " QualityPipelines" ,
138+ "softwareVersion" : " v0.1.6" ,
139+ "url" : " https://github.com/EVERSE-ResearchSoftware/QualityPipelines.git"
140+ },
141+ "author" : {
142+ "@type" : " Person" ,
143+ "name" : " Quality Pipeline"
133144 },
134145 "checks" : [
135146 {
@@ -138,39 +149,38 @@ The current output format is a `JSON`, based on the Schema presented here: https
138149 "@id" : " https://w3id.org/everse/i/indicators/license"
139150 },
140151 "checkingSoftware" : {
141- "@type" : " schema:SoftwareApplication" ,
142152 "name" : " HowFairIs" ,
143- "@id" : " https://w3id.org/everse/tools/howfairis" ,
144- "softwareVersion" : " 0.14.2"
153+ "version" : " 0.14.2"
145154 },
155+ "evidence" : " Found license file: 'LICENSE'." ,
156+ "output" : " valid" ,
146157 "process" : " Searches for a file named 'LICENSE' or 'LICENSE.md' in the repository root." ,
147158 "status" : {
148159 "@id" : " schema:CompletedActionStatus"
149- },
150- "output" : " valid" ,
151- "evidence" : " Found license file: 'LICENSE'."
160+ }
152161 },
153162 {
154163 "@type" : " CheckResult" ,
155164 "assessesIndicator" : {
156165 "@id" : " https://w3id.org/everse/i/indicators/citation"
157166 },
158167 "checkingSoftware" : {
159- "@type" : " schema:SoftwareApplication" ,
160168 "name" : " CFFConvert" ,
161- "@id" : " https://w3id.org/everse/tools/cffconvert" ,
162- "softwareVersion" : " 2.0.0"
169+ "version" : " 2.0.0"
163170 },
171+ "evidence" : " Found valid CITATION.cff file in repository root." ,
172+ "output" : " valid" ,
164173 "process" : " Searches for a 'CITATION.cff' file in the repository root and validates its syntax." ,
165174 "status" : {
166175 "@id" : " schema:CompletedActionStatus"
167- },
168- "output" : " invalid" ,
169- "evidence" : " No valid CITATION.cff file found in repository root."
176+ }
170177 }
171- ]
178+ ],
179+ "dateCreated" : " 2026-02-03 11:12:54.980348" ,
180+ "license" : " CC0-1.0"
172181}
173182```
183+
174184## Indicator Plugins
175185
176186An indicator plugin is represented by a subclass of
0 commit comments