The TiCS Github action integrates TiCS Client analysis to measure your code quality. The incorporated Quality gating feature enables you to analyze and decorate pull requests.

• A TiCS Viewer (version 2022.4 or higher) running somewhere on the network that is HTTP(S) accessible by the runner on which you want to execute the action.

• It will only be triggered on a pull request event.
• It is not working for forked repositories.
• It is not working for TiCS installations using the legacy deployment architecture.
• macOS runners (GitHub-hosted or self-hosted) are not yet supported.
• The connected runner should have Git installed.

Add the TiCS GitHub Action to your workflow to launch TiCS code analysis and post the results of Quality Gating feature as part of your pull request. Below is an example of how to include the TiCS GitHub Action step as part of your workflow:

on: [pull_request]

jobs:
  TiCS:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: TiCS GitHub Action
        uses: tiobe/tics-github-action@v2
        with:
          projectName: 'myproject'
          ticsConfiguration: 'https://url/tiobeweb/TICS/api/cfg?name=myconfiguration'
          githubToken: ${{secrets.GITHUB_TOKEN}}
          ticsAuthToken: ${{secrets.TICSAUTHTOKEN}}
          installTics: true

Linux and Windows based runners, both Github-hosted and self-hosted, are supported.

This method has been depricated as of version 2.0 and has been moved to the action parameters. The environment variables that are needed for the action to function.

env:
    GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
    TICSAUTHTOKEN: ${{secrets.TICSAUTHTOKEN}}

• GITHUB_TOKEN – Provided by Github automatically in an action (see Authenticating with the GITHUB_TOKEN).
• TICSAUTHTOKEN – It is required only when the TiCS viewer is not publicly accessible and requires an authentication token. You can create a TiCS Viewer Authentication token of role 'TICS Client' (see Configuring a token for TICS Client). You can then assign the TICSAUTHTOKEN value in the "Secrets" settings page of your repository, or add them at the level of your GitHub organization.

The following inputs are available for this action:

• This action requires Node16, it won't work with other Node versions.
• This action is written in TypeScript. To compile the package to JavaScript run npm run build.
• To package the build to run run npm run package.
• To combine the last two steps run npm run all.
• There is Prettier auto-formatting available, run npm run format or enable format on save to automate the formatting.

To enable git hooks for auto building githooks should be used. This enables the hooks in the .githooks folder. Which checks for a correct commit message and auto builds on commit.

Testing this action can be done with nektos/act. The following command can be run after installation to test the plugin.

act -s GITHUB_TOKEN=<TOKEN> -s TICSAUTHTOKEN=<TOKEN> -P self-hosted=catthehacker/ubuntu:act-latest --env PULL_REQUEST_NUMBER=<NUMBER>