-
Notifications
You must be signed in to change notification settings - Fork 65.4k
Include short example of limiting build directories #13679
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
Conversation
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request. |
|
@hohn |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hohn - thank you for this example ✨
Since this article is already very long and the example is for compiled languages only, I think it might be better to add the example to the linked article on configuring the CodeQL workflow for compiled languages.
I don't think that I can move the example on your fork, but if you can move the example then I can edit it to bring it into line with our guidelines.
The Repo freeze check failure will be fixed when we update this branch from main, so can be ignored.
|
Hi @felicitymay, I moved the example to a separate section in the file you linked. |
felicitymay
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I moved the example to a separate section in the file you linked.
@hohn - thank you so much 💖
I've edited the text to bring it more into line with our style guide.
Somehow, yesterday I managed to overlook the fact that your example calls the CodeQL CLI directly, when this article is aimed at CodeQL action users 🤦🏻♀️
I've added a suggestion with what I think the relevant content would be for the CodeQL action. Could you take a look?
I think the CodeQL CLI example itself could be added after the Multiple language example in this article about using the CLI directly.
...ode-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md
Outdated
Show resolved
Hide resolved
|
I think the test failure is spurious. |
This comment has been minimized.
This comment has been minimized.
…r-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md
...ode-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md
Outdated
Show resolved
Hide resolved
...ode-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md
Show resolved
Hide resolved
…r-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md
|
|
||
| {% note %} | ||
|
|
||
| **Note:** This approach does not work for header-only C++ libraries. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hohn - is there an alternative approach that would work for header-only C++ libraries? If not, can/should we say why this doesn't work for them?
|
We discussed this change with the PR author. We agreed that, although this example is helpful in some cases, it's not generally enough for inclusion in the docs. Omitting specific directories from compiled language extraction is an area that the development team is working on. They plan to document this when work is complete. |
|
@hohn - many thanks for suggesting this example and bringing this discussion to the fore. It's much appreciated. |
Why:
Add example of limiting compiled language builds
What's being changed:
Add example of limiting compiled language builds
Check off the following:
Writer impact (This section is for GitHub staff members only):