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

Add Security Scan: CodeQL workflow #170

Merged
merged 1 commit into from
May 26, 2021

Conversation

KKelvinLo
Copy link
Member

@KKelvinLo KKelvinLo commented May 20, 2021

Motivation

This PR is a follow-up to issue open-telemetry/oteps#144

CodeQL is GitHub's static analysis engine which scans repos for security vulnerabilities. As the project grows and we near GA it might be useful to have a workflow which checks for security vulnerabilities to ensure that every incremental change is following best development practices. Also passing basic security checks will also make sure that there aren't any glaring issues for our users.

Changes

  • This PR adds CodeQL security checks to the repository
  • After every run the workflow will upload the results to GitHub.

Current CodeQL run from fork

Workflow Triggers

  • daily cron job at 1:30 am
  • workflow_dispatch (in the case that the maintainers want to trigger a manual security check)

@KKelvinLo KKelvinLo requested a review from a team May 20, 2021 19:46
@pellared
Copy link
Member

pellared commented May 20, 2021

Thanks for the PR 👍

Can you please add:

  1. scanning C++ code
  2. hyperlinks from the fork's GitHub Actions to show that it is really working

@KKelvinLo
Copy link
Member Author

Thanks for the PR 👍

Can you please add:

  1. scanning C++ code
  2. hyperlinks from the fork's GitHub Actions to show that it is really working

I have added the hyperlink to the fork run.

Also I have tried adding the C++ scan, but CodeQL fails to automatically build the C++ code. Similarly in the C++ SDK CodeQL work flow there was a simple setup step where I had to setup the manual dependencies/tools - perhaps you can point me to the manual dependencies / tooling setup for the C++ portion?

@pellared
Copy link
Member

pellared commented May 20, 2021

I hope this will be helpful:

@KKelvinLo
Copy link
Member Author

I opened an issue to add C++ code scanning - #178 . To avoid delay, is it possible to approve this pull-request and merge in the C# CodeQL scanning.

@nrcventura nrcventura merged commit fc05885 into open-telemetry:main May 26, 2021
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