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 CodeQL workflow for GitHub code scanning #235

Merged
merged 1 commit into from
Nov 25, 2022

Conversation

lgtm-com[bot]
Copy link
Contributor

@lgtm-com lgtm-com bot commented Nov 9, 2022

Hi Sage-Bionetworks/challengeutils!

This is a one-off automatically generated pull request from LGTM.com 🤖. You might have heard that we’ve integrated LGTM’s underlying CodeQL analysis engine natively into GitHub. The result is GitHub code scanning!

With LGTM fully integrated into code scanning, we are focused on improving CodeQL within the native GitHub code scanning experience. In order to take advantage of current and future improvements to our analysis capabilities, we suggest you enable code scanning on your repository. Please take a look at our blog post for more information.

This pull request enables code scanning by adding an auto-generated codeql.yml workflow file for GitHub Actions to your repository — take a look! We tested it before opening this pull request, so all should be working ✔️. In fact, you might already have seen some alerts appear on this pull request!

Where needed and if possible, we’ve adjusted the configuration to the needs of your particular repository. But of course, you should feel free to tweak it further! Check this page for detailed documentation.

Questions? Check out the FAQ below!

FAQ

Click here to expand the FAQ section

How often will the code scanning analysis run?

By default, code scanning will trigger a scan with the CodeQL engine on the following events:

  • On every pull request — to flag up potential security problems for you to investigate before merging a PR.
  • On every push to your default branch and other protected branches — this keeps the analysis results on your repository’s Security tab up to date.
  • Once a week at a fixed time — to make sure you benefit from the latest updated security analysis even when no code was committed or PRs were opened.

What will this cost?

Nothing! The CodeQL engine will run inside GitHub Actions, making use of your unlimited free compute minutes for public repositories.

What types of problems does CodeQL find?

The CodeQL engine that powers GitHub code scanning is the exact same engine that powers LGTM.com. The exact set of rules has been tweaked slightly, but you should see almost exactly the same types of alerts as you were used to on LGTM.com: we’ve enabled the security-and-quality query suite for you.

How do I upgrade my CodeQL engine?

No need! New versions of the CodeQL analysis are constantly deployed on GitHub.com; your repository will automatically benefit from the most recently released version.

The analysis doesn’t seem to be working

If you get an error in GitHub Actions that indicates that CodeQL wasn’t able to analyze your code, please follow the instructions here to debug the analysis.

How do I disable LGTM.com?

If you have LGTM’s automatic pull request analysis enabled, then you can follow these steps to disable the LGTM pull request analysis. You don’t actually need to remove your repository from LGTM.com; it will automatically be removed in the next few months as part of the deprecation of LGTM.com (more info here).

Which source code hosting platforms does code scanning support?

GitHub code scanning is deeply integrated within GitHub itself. If you’d like to scan source code that is hosted elsewhere, we suggest that you create a mirror of that code on GitHub.

How do I know this PR is legitimate?

This PR is filed by the official LGTM.com GitHub App, in line with the deprecation timeline that was announced on the official GitHub Blog. The proposed GitHub Action workflow uses the official open source GitHub CodeQL Action. If you have any other questions or concerns, please join the discussion here in the official GitHub community!

I have another question / how do I get in touch?

Please join the discussion here to ask further questions and send us suggestions!

@lgtm-com lgtm-com bot requested a review from a team as a code owner November 9, 2022 08:11
@thomasyu888 thomasyu888 merged commit 1239e9d into Sage-Bionetworks:develop Nov 25, 2022
vpchung added a commit that referenced this pull request Mar 17, 2023
* fix UnboundLocalError when calling `valid` in command_validate_docker (#224)

* Add code owners (#227)

* Add code owners

* Add extra line

* Make code of conduct changes (#228)

* Add setup.cfg (#229)

* Add setup.cfg

* lint and fix versioning

* Add HACK comment

* Use black (#230)

* Add black

* Lint

* Lint with black

* Give Organizers team "Moderate"-level access to live project (#233)

* add new MODERATE permission level

* give organizers team moderate permissions to live site

* add CLI function for adding Moderator flair

* update test

* fix lint

* Add CodeQL workflow for GitHub code scanning (#235)

Co-authored-by: LGTM Migrator <lgtm-migrator@users.noreply.github.com>

* Add support for py10 (#237)

* Add support for py10

* Fix requirements

* use v3 (#236)

* Update cmd name in setup config (#239)

* update cmd name

* fix lint (#240)

* Update requirements file for dev env (#241)

* update requirements file for dev env

* update synapseclient version

* Cheat detection (#242)

* Adding cheat detection functions

* add additional comments and documentation

* added in rst module description

* adding in cheat detection tests

* add in tests and evaluation round limit handlers

* make testing adjustments

* added package installation and command line fixes

* adding in exception handling

* additional exception handling

* documentation and descriptions

* adjust the scipy install requirements

* making lint happy

* Update challengeutils/__main__.py

Co-authored-by: Verena Chung <9377970+vpchung@users.noreply.github.com>

* lint changes

* making the linter happy

* making the linter happyy and adding in additional exception handling

* lint changes

* making the linter happy

* linting

* linting

* linting

* Exception handling

---------

Co-authored-by: Timothy Bergquist <tbergquist@Timothys-MacBook-Air.local>
Co-authored-by: Timothy Bergquist <tbergquist@Timothys-Air.localdomain>
Co-authored-by: Verena Chung <9377970+vpchung@users.noreply.github.com>

* add pre-commit

* run pre-commit on all files

* update readme

* update readme

* Release v4.2 (#244)

* update version

* add changelog for this release

---------

Co-authored-by: Thomas Yu <thomas.yu@sagebase.org>
Co-authored-by: lgtm-com[bot] <43144390+lgtm-com[bot]@users.noreply.github.com>
Co-authored-by: LGTM Migrator <lgtm-migrator@users.noreply.github.com>
Co-authored-by: Timothy Bergquist <timothy.bergquist@sagebase.org>
Co-authored-by: Timothy Bergquist <tbergquist@Timothys-MacBook-Air.local>
Co-authored-by: Timothy Bergquist <tbergquist@Timothys-Air.localdomain>
Co-authored-by: mdsage1 <122999770+mdsage1@users.noreply.github.com>
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