Skip to content
This repository has been archived by the owner on May 25, 2022. It is now read-only.

Add CodeQL Security Scans #153

Merged
merged 4 commits into from
May 21, 2021
Merged

Conversation

kxyr
Copy link

@kxyr kxyr commented May 20, 2021

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

@kxyr kxyr requested a review from a team May 20, 2021 01:01
Copy link
Member

@djaglowski djaglowski left a comment

Choose a reason for hiding this comment

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

Thank you for adding this.

Just a minor note on the changelog format.

CHANGELOG.md Show resolved Hide resolved
xukaren and others added 2 commits May 20, 2021 11:40
Co-authored-by: Daniel Jaglowski <jaglows3@gmail.com>
@djaglowski
Copy link
Member

It appears we have a bit of a chicken/egg situation, as one of the new checks wishes to compare results to previous scans on main.

I think we may need to temporarily modify main branch protection rules to allow this PR to be merged. @tigrannajaryan Does this seem reasonable?

@tigrannajaryan
Copy link
Member

It appears we have a bit of a chicken/egg situation, as one of the new checks wishes to compare results to previous scans on main.

I think we may need to temporarily modify main branch protection rules to allow this PR to be merged. @tigrannajaryan Does this seem reasonable?

I don't see any failed checks that prevent merging. All seems OK?
image

@djaglowski djaglowski merged commit e0a63ec into open-telemetry:main May 21, 2021
@djaglowski
Copy link
Member

My mistake, I wasn't aware of neutral checks and was thinking about it in binary.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants