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 configuration #363

Merged
merged 1 commit into from
Oct 17, 2024
Merged

Conversation

jentfoo
Copy link
Contributor

@jentfoo jentfoo commented Oct 16, 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 16, 2024
@jentfoo jentfoo requested a review from a team as a code owner October 16, 2024 18:13
@github-advanced-security
Copy link

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.

Copy link

- cron: '0 13 * * 1' # At 1:00 PM UTC every Monday
pull_request:
paths:
- '.github/workflows/codeql.yaml'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want this to run on every PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the future that is the goal. However right now I don't want people to burden themselves with these alerts until I am able to triage and make sure that we don't have a lot of false positive noise first.

But if we decide CodeQL is a good option going forward, I would like to have the feedback provided early, at the PR.

@jentfoo jentfoo merged commit 9637022 into main Oct 17, 2024
14 checks passed
@jentfoo jentfoo deleted the jent/codeql branch October 17, 2024 13:37
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.

2 participants