tiobe/TICS Code Quality Analysis

Analyze your code quality with TICS Client. Integrated quality gating allows for decorated pull request reviews.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
viewerUrlThe URL pointing to the "cfg" API endpoint of the TICS Viewer. It contains the name of the TICS Analyzer Configuration or "-" in case of the default configurationyes
modeSet the mode to run the action in. Options are `client` or `qserver` for an analysis run and `diagnostic` for a diagnostic run to test the setup. Default is `client`.noclient
projectName of the TICS project. In client mode this will default to project `auto`, in server mode it is mandatory.noauto
githubTokenno${{ github.token }}
additionalFlagsOption to add flags to the TICS command.no
branchnameName of the branch in TICS.no
branchdirLocation of the files to analyze (only applies to QServer runs).no
calcComma-separated list of metrics to be calculated. GATE metric is supported for TICS Viewer versions higher than 2022.2.x.no
createProjectCreate the project in the TICS Viewer if it does not exist already (only in server mode).nofalse
nocalcComma-separated list of metrics not to be calculated.no
recalcComma-separated list of metrics to be recalculated. GATE metric is supported for TICS Viewer versions higher than 2022.2.x.no
norecalcComma-separated list of metrics not to be recalculated.no
cdtokenA custom client-data token for the purpose of the Client Viewer functionality (only applies to Client runs).no
codetypeAllows you to pick which specific types of code you want to analyze with the (only applies to Client runs).no
excludeMovedFilesExclude moved files from analysis even if there are modifications in the file.nofalse
filelistPath to a file containing the files (newline separated) to run TICS for. This can be an absolute or relative (to workspace) path, and can also be `.` to analyze the whole project. This has to be set when the action is run outside of a pull request.no
hostnameVerificationCheck whether the certificate matches the server. Options are `1`/`true` or `0`/`false`. [Documentation on Client-side SSL/TLS](https://portal.tiobe.com/2022.2/docs/#doc=admin/admin_11_viewer.html%23ssl-wrapper).notrue
trustStrategyCheck the validity of certificates. Options are `all`, `self-signed` or `strict`. [Documentation on Client-side SSL/TLS](https://portal.tiobe.com/2022.2/docs/#doc=admin/admin_11_viewer.html%23ssl-wrapper).nostrict
installTicsBoolean parameter to install TICS command-line tools on a runner before executing the analysis.nofalse
postAnnotationsShow the TICS violations in the changed files window. Options are `true` or `false` (default is `true`).notrue
postToConversationPost the summary to the conversation page of the pull request. Options are `true` (default) or `false`.notrue
pullRequestApprovalSet the plugin to approve or deny a pull request, by default this is false. Options are `true` or `false`. Note that once a run that added a reviewer has been completed, this reviewer cannot be deleted from that pull request. (Always the case on versions between 2.0.0 and 2.5.0).nofalse
retryCodesStatus codes to retry api calls for. The default codes will be overwritten if this option is set.no
secretsFilterComma-seperated list of extra secrets to mask in the console output.no
showBlockingAfter(deprecated) !Will not be used if `showAnnotationSeverity` is set! Show the blocking after TICS violations in the changed files window (will also show up in `outputs.annotations`). Options are `true` or `false` (default is `true`).notrue
showAnnotationSeverityShow TICS violations with at least the specified severity in the changed files window (will also show up in `outputs.annotations`). Options are `blocking`, `blocking-after` or `issue` (default is `blocking-after`).no
ticsAuthTokenAuthentication token to authorize the plugin when it connects to the TICS Viewer.no
tmpdirLocation to store debug information.no
displayUrlThe publicly available Viewer URL of TICS viewer to link the links in the review to. (e.g. https://domain.com/tiobeweb/TICS)no
namedescription
annotationsAll annotations the action has reported in JSON format.