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 Stuart parameter to this repo #136

Merged
merged 1 commit into from
Mar 10, 2023

Conversation

makubacki
Copy link
Member

Description

Allows CodeQL to be run locally by specifying --codeql when
providing stuart_update and stuart_ci_build commands in this
repo.

  • stuart_update - Automatically downloads the CodeQL CLI application
    appropriate for your host operating system
    • Note: This may take several minutes depending on your Internet
      connection speed
  • stuart_ci_build - Automatically runs CodeQL against the packages
    built after they are built.

NOTE: Running with CodeQL will increase your overall build time for a
couple of reasons:

  1. Every package must be clean built to get proper results
  2. The CodeQL analysis phase takes a while to run

(1) happens automatically, you do not need to specify a clean build
manually

For more information, such as:

  1. How to view results
  2. How to modify the CodeQL rules run
  3. How to include/exclude files/rules at various levels of granularity

And more...

Go to the CodeQL plugin readme:

https://github.com/microsoft/mu_basecore/blob/HEAD/.pytool/Plugin/CodeQL/Readme.md


  • Impacts functionality?
    • Functionality - Does the change ultimately impact how firmware functions?
    • Examples: Add a new library, publish a new PPI, update an algorithm, ...
  • Impacts security?
    • Security - Does the change have a direct security impact on an application,
      flow, or firmware?
    • Examples: Crypto algorithm change, buffer overflow fix, parameter
      validation improvement, ...
  • Breaking change?
    • Breaking change - Will anyone consuming this change experience a break
      in build or boot behavior?
    • Examples: Add a new library class, move a module to a different repo, call
      a function in a new library class in a pre-existing module, ...
  • Includes tests?
    • Tests - Does the change include any explicit test code?
    • Examples: Unit tests, integration tests, robot tests, ...
  • Includes documentation?
    • Documentation - Does the change contain explicit documentation additions
      outside direct code modifications (and comments)?
    • Examples: Update readme file, add feature readme file, link to documentation
      on an a separate Web page, ...

How This Was Tested

Verified --codeql usage with stuart_update and stuart_ci_build locally.

Integration Instructions

See earlier PR description and CodeQL plugin readme:

https://github.com/microsoft/mu_basecore/blob/HEAD/.pytool/Plugin/CodeQL/Readme.md

Signed-off-by: Michael Kubacki michael.kubacki@microsoft.com

@github-actions github-actions bot added the impact:non-functional Does not have a functional impact label Mar 10, 2023
@codecov-commenter
Copy link

codecov-commenter commented Mar 10, 2023

Codecov Report

Merging #136 (56ad203) into main (afe41b5) will not change coverage.
The diff coverage is n/a.

❗ Current head 56ad203 differs from pull request most recent head afec226. Consider uploading reports for the commit afec226 to get more accurate results

@@           Coverage Diff           @@
##             main     #136   +/-   ##
=======================================
  Coverage   28.29%   28.29%           
=======================================
  Files          15       15           
  Lines        4407     4407           
=======================================
  Hits         1247     1247           
  Misses       3160     3160           
Flag Coverage Δ
Linux 28.29% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Allows CodeQL to be run locally by specifying `--codeql` when
providing `stuart_update` and `stuart_ci_build` commands in this
repo.

- `stuart_update` - Automatically downloads the CodeQL CLI application
  appropriate for your host operating system
  - Note: This may take several minutes depending on your Internet
    connection speed
- `stuart_ci_build` - Automatically runs CodeQL against the packages
  built after they are built.

NOTE: Running with CodeQL will increase your overall build time for a
couple of reasons:

1. Every package must be clean built to get proper results
2. The CodeQL analysis phase takes a while to run

  (1) happens automatically, you do not need to specify a clean build
  manually

For more information, such as:

1. How to view results
2. How to modify the CodeQL rules run
3. How to include/exclude files/rules at various levels of granularity

And more...

Go to the CodeQL plugin readme:

https://github.com/microsoft/mu_basecore/blob/HEAD/.pytool/Plugin/CodeQL/Readme.md

Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
@makubacki makubacki enabled auto-merge (squash) March 10, 2023 02:15
@makubacki makubacki merged commit 23eee2d into microsoft:main Mar 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
impact:non-functional Does not have a functional impact
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants