The Wayback Machine - http://web.archive.org/web/20220410084637/https://github.com/github/docs/issues/15967
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

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

Open
1 task done
felicitymay opened this issue Mar 1, 2022 · 1 comment
Open
1 task done

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

felicitymay opened this issue Mar 1, 2022 · 1 comment
Assignees
Labels
content MLH fellowship

Comments

@felicitymay
Copy link
Contributor

@felicitymay felicitymay commented Mar 1, 2022

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 help wanted MLH fellowship labels Mar 1, 2022
@github-actions github-actions bot added the triage label Mar 1, 2022
@felicitymay felicitymay removed the triage label Mar 1, 2022
@felicitymay felicitymay added this to Weeks 4-6 in MLH Fellowship Mar 1, 2022
@applnew777
Copy link

@applnew777 applnew777 commented Mar 1, 2022

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 label Mar 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content MLH fellowship
Projects
Development

No branches or pull requests

4 participants