Skip to content

Conversation

@hohn
Copy link
Contributor

@hohn hohn commented Jan 3, 2022

Why:

Add example of limiting compiled language builds

What's being changed:

Add example of limiting compiled language builds

Check off the following:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

@welcome
Copy link

welcome bot commented Jan 3, 2022

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.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 3, 2022

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 that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You 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.

Source Staging Production What Changed
content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md Modified Original

@github-actions github-actions bot temporarily deployed to docs-13679--patch-2 January 3, 2022 19:41 Inactive
@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review labels Jan 4, 2022
@ramyaparimi
Copy link
Contributor

@hohn
Thanks so much for opening a PR! I'll get this triaged for review ⚡

Copy link
Contributor

@felicitymay felicitymay left a 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.

@hohn
Copy link
Contributor Author

hohn commented Jan 11, 2022

Hi @felicitymay, I moved the example to a separate section in the file you linked.

@github-actions github-actions bot temporarily deployed to docs-13679--patch-2 January 11, 2022 19:54 Inactive
@github-actions github-actions bot temporarily deployed to docs-13679--patch-2 January 12, 2022 15:48 Inactive
Copy link
Contributor

@felicitymay felicitymay left a 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.

@felicitymay
Copy link
Contributor

I think the test failure is spurious.

@github-actions github-actions bot temporarily deployed to docs-13679--patch-2 January 12, 2022 16:54 Inactive
@Hadwanvelasco

This comment has been minimized.

…r-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md
@github-actions github-actions bot temporarily deployed to docs-13679--patch-2 January 13, 2022 09:18 Inactive
…r-code-for-vulnerabilities-and-errors/configuring-the-codeql-workflow-for-compiled-languages.md
@github-actions github-actions bot temporarily deployed to docs-13679--patch-2 January 13, 2022 09:24 Inactive

{% note %}

**Note:** This approach does not work for header-only C++ libraries.
Copy link
Contributor

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?

@github-actions github-actions bot temporarily deployed to docs-13679--patch-2 January 13, 2022 09:40 Inactive
@felicitymay
Copy link
Contributor

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.

@felicitymay
Copy link
Contributor

@hohn - many thanks for suggesting this example and bringing this discussion to the fore. It's much appreciated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants