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

chore(ci): Add initial CodeQL Workflow #1655

Merged
merged 1 commit into from
Oct 16, 2024
Merged

chore(ci): Add initial CodeQL Workflow #1655

merged 1 commit into from
Oct 16, 2024

Conversation

jentfoo
Copy link
Contributor

@jentfoo jentfoo commented Oct 15, 2024

I want to explore using CodeQL to assist as part of our static analysis strategy. Because this tool is available for free to open source projects, opentdf is a good place to start this testing.

This PR adds an initial configuration which will scan the codebase once a week. These results can be ignored for the time being. Instead the security team will review the results and make sure we tune away any noise first (or help in opening PR's to address any valid issues found).

@jentfoo jentfoo self-assigned this Oct 15, 2024
@jentfoo jentfoo requested review from a team as code owners October 15, 2024 21:48
@jentfoo jentfoo changed the title Add initial CodeQL Workflow chore: Add initial CodeQL Workflow Oct 15, 2024
@jentfoo jentfoo changed the title chore: Add initial CodeQL Workflow chore(ci) Add initial CodeQL Workflow Oct 15, 2024
@jentfoo jentfoo marked this pull request as draft October 15, 2024 21:50
@jakedoublev
Copy link
Contributor

Thanks for this @jentfoo We already have a nightly checks job for long-running tasks and I'm wondering if we should add this job to that GHA. Is there any pro/con you see to running this nightly instead of weekly and grouping it within those checks?

@jrschumacher
Copy link
Member

@jentfoo were trying to keep non-OpenTDF issues out of the OpenTDF repo so there is full transparency. Any issues with removing the back link?

@github-advanced-security
Copy link
Contributor

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@jentfoo jentfoo marked this pull request as ready for review October 15, 2024 21:56
@jentfoo
Copy link
Contributor Author

jentfoo commented Oct 15, 2024

@jrschumacher removed

@jakedoublev I considered adding it to the nightly tasks, but I did not see an obvious advantage to doing so. I initially had this as a draft trying to confirm that the auto build is sufficient, and it seems initially that it is.

I would prefer to keep this independent. Although this is starting as a weekly run, if we do decide to stick with CodeQL long term, I would like to transition it to run as a PR check so that feedback can be promptly provided. Currently it seems to finish similar to other PR checks (~1min total), but I want to make sure results are tuned before it becomes a PR level check.

Let me know if you have any additional thoughts, but that would be my primary argument for keeping this isolated.

Thank you both for the quick look!

@jentfoo jentfoo changed the title chore(ci) Add initial CodeQL Workflow chore(ci): Add initial CodeQL Workflow Oct 15, 2024
@jakedoublev
Copy link
Contributor

This looks good to me, but I'm unsure if we're in a code freeze for the release at present. This GHA update would have no impact on the release as there are no code changes, but it would make reverting or adding recent commits to main more challenging, so I will hold off on ✅ and defer to @opentdf/architecture .

@jrschumacher
Copy link
Member

I'm approving this since it's just CI

@jrschumacher jrschumacher added this pull request to the merge queue Oct 15, 2024
Merged via the queue into main with commit c486712 Oct 16, 2024
22 of 24 checks passed
@jrschumacher jrschumacher deleted the jent/codeql branch October 16, 2024 00:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants