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

ci: codeql: add the language to the category #6179

Closed
wants to merge 1 commit into from

Conversation

kmk3
Copy link
Collaborator

@kmk3 kmk3 commented Jan 30, 2024

@github-advanced-security
Copy link

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

@kmk3 kmk3 marked this pull request as draft February 1, 2024 00:11
@kmk3 kmk3 changed the title ci: specify language in codeql analysis ci: codeql: add the language to the category Sep 28, 2024
@kmk3
Copy link
Collaborator Author

kmk3 commented Sep 28, 2024

This seems to be intended for when multiple languages are analysed in the same
workflow:

From https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#configuring-a-category-for-the-analysis:

If you don't specify a category parameter in your workflow, GitHub will
generate a category name for you, based on the name of the workflow file
triggering the action, the action name, and any matrix variables. For
example:

  • The .github/workflows/codeql-analysis.yml workflow and the analyze
    action will produce the category .github/workflows/codeql.yml:analyze.
  • The .github/workflows/codeql-analysis.yml workflow, the analyze action,
    and the {language: javascript-typescript, os: linux} matrix variables
    will produce the category
    .github/workflows/codeql-analysis.yml:analyze/language:javascript-typescript/os:linux.

The category value will appear as the <run>.automationDetails.id property
in SARIF v2.1.0. For more information, see "SARIF support for code
scanning
."

Not sure if adding this would actually help or only add noise, so closing.

@kmk3 kmk3 closed this Sep 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Reverted (RELNOTES N/A)
Development

Successfully merging this pull request may close these issues.

2 participants