Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: integration with TiCS code quality analysis #138

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

cjdcordeiro
Copy link
Collaborator

  • Have you signed the CLA?

This PR introduces the TiCS analyzer with the Chisel CI.

How it works

On every PR

TiCS job will run in "client" mode, analyzing the changed files in the PR. As a result, it will create code annotations and write a comment to the PR with a summary of the analysis. Example: cjdcordeiro#3 (comment)

On-demand and on-schedule

At least once a day, this job will also run in "qserver" mode, meaning that it will do a full analysis of the Chisel project and send the results to our remote dashboard in Tiobe. Here's an example of such run: https://github.com/cjdcordeiro/chisel/actions/runs/9480198560 (and the corresponding view in the dashboard)

@cjdcordeiro
Copy link
Collaborator Author

@letFunny are the annotations in https://github.com/cjdcordeiro/chisel/actions/runs/9480198560 legit? The coverage issue we saw a few days ago has been fixed (the tool requires a pre-existing coverage report).

Use a pull_request_target event instead, which runs
on the context of the base repo. As such, this
commit makes the definition of the project repo and
ref explicit, such that the TiCS job can still
analyze the PR's code, but without running
potentially harmful CI scripts from the author.
@cjdcordeiro cjdcordeiro marked this pull request as draft June 12, 2024 14:27
@cjdcordeiro cjdcordeiro marked this pull request as draft June 12, 2024 14:27
@cjdcordeiro cjdcordeiro marked this pull request as draft June 12, 2024 14:27
@cjdcordeiro cjdcordeiro added the Blocked Waiting for something external label Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Blocked Waiting for something external
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant