Skip to content

Commit

Permalink
Chore: Suppress unqualified CodeQL admonitions
Browse files Browse the repository at this point in the history
GitHub's CodeQL flags [1] those spots with "Unused global variable" [2].

Based on a suggestion [3], this patch attempts to use the
`advanced-security/dismiss-alerts` [4] GitHub Action recipe to provide
measures to suppress CodeQL flagging by using inline code annotations.

[1] https://github.com/crate/crate-python/security/code-scanning
[2] https://codeql.github.com/codeql-query-help/python/py-unused-global-variable/
[3] Issue 11427 at https://github.com/github/codeql/issues
[4] https://github.com/advanced-security/dismiss-alerts
  • Loading branch information
amotl committed Nov 23, 2024
1 parent a126030 commit be97a8d
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
19 changes: 19 additions & 0 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ jobs:
languages: ${{ matrix.language }}
config-file: ./.github/codeql.yml
queries: +security-and-quality
# run an 'alert-suppression' query
packs: "codeql/${{ matrix.language }}-queries:AlertSuppression.ql"

#- name: Autobuild
# uses: github/codeql-action/autobuild@v2
Expand All @@ -62,4 +64,21 @@ jobs:
uv pip install --system '.[test]'
- name: Perform CodeQL Analysis
id: analyze
uses: github/codeql-action/analyze@v3
with:
category: "/language:${{matrix.language}}"
# define the output folder for SARIF files
output: sarif-results

# Unlock inline mechanism to suppress CodeQL warnings.
# https://github.com/github/codeql/issues/11427#issuecomment-1721059096
- name: Dismiss alerts
# if: github.ref == 'refs/heads/main'
uses: advanced-security/dismiss-alerts@v1
with:
# specify a 'sarif-id' and 'sarif-file'
sarif-id: ${{ steps.analyze.outputs.sarif-id }}
sarif-file: sarif-results/${{ matrix.language }}.sarif
env:
GITHUB_TOKEN: ${{ github.token }}
1 change: 1 addition & 0 deletions src/crate/client/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
# regex!
__version__ = "1.0.0"

# codeql[py/unused-global-variable]
apilevel = "2.0"
threadsafety = 1
paramstyle = "qmark"

0 comments on commit be97a8d

Please sign in to comment.