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.

Sign up for GitHub

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

Jump to bottom

[User feedback] Add new troubleshooting section to CodeQL article #15967

Closed
1 task done
felicitymay opened this issue Mar 1, 2022 · 1 comment · Fixed by #17116
Closed
1 task done

[User feedback] Add new troubleshooting section to CodeQL article #15967

felicitymay opened this issue Mar 1, 2022 · 1 comment · Fixed by #17116
Assignees
@cmwilson21
Labels
content This issue or pull request belongs to the Docs Content team MLH fellowship This issue is reserved for the MLH Fellowship program

Comments

@felicitymay
Copy link
Contributor

Code of Conduct

What article on docs.github.com is affected?

Troubleshooting the CodeQL workflow

What part(s) of the article would you like to see updated?

Question from user:

"In my workload, analysis fails on generated code (which is thus known to be good). How can I suppress such false positives?"

Docs update needed:

Troubleshooting the CodeQL workflow

  • In the section "Reduce the amount of code being analyzed in a single workflow", convert the 2nd, 3rd and 4th paragraphs to a reusable.
  • Add a new section called "Alerts found in generated code" use the new reusable.

For information about reusables, see Reusables and variables and docs/data/reusables/README.md

Additional information

Showing the same content twice in one article may seem strange. However, this will make it more discoverable for users who want to exclude code from analysis for reasons apart from their build taking too long.
@felicitymay felicitymay added content This issue or pull request belongs to the Docs Content team help wanted Anyone is welcome to open a pull request to fix this issue MLH fellowship This issue is reserved for the MLH Fellowship program labels Mar 1, 2022
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 1, 2022
@felicitymay felicitymay removed the triage Do not begin working on this issue until triaged by the team label Mar 1, 2022
@applnew777
Copy link

Code of Conduct

What article on docs.github.com is affected?

Troubleshooting the CodeQL workflow

What part(s) of the article would you like to see updated?

Question from user:

"In my workload, analysis fails on generated code (which is thus known to be good). How can I suppress such false positives?"

Docs update needed:

Troubleshooting the CodeQL workflow

  • In the section "Reduce the amount of code being analyzed in a single workflow", convert the 2nd, 3rd and 4th paragraphs to a reusable.
  • Add a new section called "Alerts found in generated code" use the new reusable.

For information about reusables, see Reusables and variables and docs/data/reusables/README.md

Additional information

Showing the same content twice in one article may seem strange. However, this will make it more discoverable for users who want to exclude code from analysis for reasons apart from their build taking too long.

@cmwilson21 cmwilson21 self-assigned this Mar 15, 2022
@janiceilene janiceilene removed the help wanted Anyone is welcome to open a pull request to fix this issue label Mar 17, 2022
@cmwilson21 cmwilson21 mentioned this issue Apr 15, 2022
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cmwilson21 cmwilson21

Labels
content This issue or pull request belongs to the Docs Content team MLH fellowship This issue is reserved for the MLH Fellowship program
Projects
MLH Fellowship
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add new troubleshooting codeql cmwilson21/docs
4 participants
@felicitymay @janiceilene @cmwilson21 @applnew777