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

Adding CodeQL security scan workflow #1505

Merged
merged 2 commits into from
Jan 7, 2021

Conversation

shovnik
Copy link
Contributor

@shovnik shovnik commented Dec 30, 2020

Motivation

Follow up to issue 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 with every PR so we can ensure 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 repo
  • After every run the workflow uploads the results to GitHub. Details on the run and security alerts will show up in the security tab of this repo.

Workflow Triggers

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

cc- @alolita

@shovnik shovnik requested review from a team, codeboten and lzchen and removed request for a team December 30, 2020 17:32
@codeboten codeboten added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Dec 31, 2020
Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

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

Nice, thanks for enabling this

@lzchen
Copy link
Contributor

lzchen commented Jan 4, 2021

workflow_dispatch (in case maintainers want to trigger a security check manually)

How does one trigger a security check manually with workflow_dispatch?

@codeboten
Copy link
Contributor

@shovnik if you have a chance to update the branch, we could get this merged.

@shovnik
Copy link
Contributor Author

shovnik commented Jan 6, 2021

Updated the branch. Also to trigger the workflow manually if needed, there should be a Run Workflow button in the top right of the actions tab of the repo.
https://github.blog/changelog/2020-07-06-github-actions-manual-triggers-with-workflow_dispatch/

@codeboten codeboten merged commit ff1a058 into open-telemetry:master Jan 7, 2021
@alolita
Copy link
Member

alolita commented Jan 7, 2021

Many thanks @shovnik

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants