Skip to content

Commit 7e17aca

Browse files
authored
Merge branch 'main' into rachmari-patch-1
2 parents 8fd1378 + b527962 commit 7e17aca

9 files changed

Lines changed: 87 additions & 9 deletions

File tree

content/developers/apps/scopes-for-oauth-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Name | Description
7171
**`admin:gpg_key`** | Fully manage GPG keys.
7272
 `write:gpg_key`| Create, list, and view details for GPG keys.
7373
 `read:gpg_key`| List and view details for GPG keys.{% if currentVersion == "free-pro-team@latest" %}
74-
**`workflow`** | Grants the ability to add and update {% data variables.product.prodname_actions %} workflow files. Workflow files can be committed without this scope if the same file (with both the same path and contents) exists on another branch in the same repository.{% endif %}
74+
**`workflow`** | Grants the ability to add and update {% data variables.product.prodname_actions %} workflow files. Workflow files can be committed without this scope if the same file (with both the same path and contents) exists on another branch in the same repository. Workflow files can expose `GITHUB_TOKEN` which may have a different set of scopes, see https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#permissions-for-the-github_token for details.{% endif %}
7575

7676
{% note %}
7777

content/github/customizing-your-github-workflow/github-extensions-and-integrations.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ versions:
1010

1111
### Editor tools
1212

13-
To streamline your workflow, you can connect to {% data variables.product.product_name %} repositories within third-party editor tools, such as Atom, Unity, and Visual Studio.
13+
You can connect to {% data variables.product.product_name %} repositories within third-party editor tools, such as Atom, Unity, and Visual Studio.
1414

1515
#### {% data variables.product.product_name %} for Atom
1616

@@ -30,8 +30,12 @@ With the {% data variables.product.prodname_dotcom %} for Visual Studio Code ext
3030

3131
### Project management tools
3232

33-
To streamline your workflow, you can integrate your {% data variables.product.product_name %} personal account or organization with third-party project management tools, such as Jira.
33+
You can integrate your {% data variables.product.product_name %} personal account or organization with third-party project management tools, such as Jira or Slack.
3434

3535
#### Jira Cloud and {% data variables.product.product_name %}.com integration
3636

37-
You can integrate Jira Cloud with your personal or organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues.
37+
You can integrate Jira Cloud with your personal or organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues. For more information, visit the [Jira integration app](https://github.com/marketplace/jira-software-github) in the marketplace.
38+
39+
#### Slack and {% data variables.product.product_name %} integration
40+
41+
You can integrate Slack with your personal or organization account to subscribe for notifications, close or open issues, and provide rich references to issues and pull requests without leaving Slack. For more information, visit the [Slack integration app](https://github.com/marketplace/slack-github) in the marketplace.

content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ versions:
1818
{% link_in_list /configuring-code-scanning %}
1919
{% link_in_list /configuring-the-codeql-workflow-for-compiled-languages %}
2020
{% link_in_list /troubleshooting-the-codeql-workflow %}
21+
{% link_in_list /running-codeql-code-scanning-in-a-container %}
2122
{% topic_link_in_list /integrating-with-code-scanning %}
2223
{% link_in_list /about-integration-with-code-scanning %}
2324
{% link_in_list /uploading-a-sarif-file-to-github %}
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: 'Running CodeQL code scanning in a container'
3+
shortTitle: '{% data variables.product.prodname_code_scanning_capc %} in a container'
4+
intro: 'You can run {% data variables.product.prodname_code_scanning %} in a container by ensuring that all processes run in the same container.'
5+
product: '{% data reusables.gated-features.code-scanning %}'
6+
versions:
7+
free-pro-team: '*'
8+
enterprise-server: '>=2.22'
9+
---
10+
11+
{% data reusables.code-scanning.beta %}
12+
13+
### About {% data variables.product.prodname_code_scanning %} with a containerized build
14+
15+
If you're setting up {% data variables.product.prodname_code_scanning %} for a compiled language, and you're building the code in a containerized environment, the analysis may fail with the error message "No source code was seen during the build." This indicates that {% data variables.product.prodname_codeql %} was unable to monitor your code as it was compiled.
16+
17+
You must run {% data variables.product.prodname_codeql %} in the same container in which you build your code. This applies whether you are using the {% data variables.product.prodname_codeql_runner %}, or {% data variables.product.prodname_actions %}. If you're using the {% data variables.product.prodname_codeql_runner %}, run it in the container where your code builds. For more information about the {% data variables.product.prodname_codeql_runner %}, see "[Running {% data variables.product.prodname_codeql %} in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-code-scanning-in-your-ci-system)." If you're using {% data variables.product.prodname_actions %}, configure your workflow to run all the actions in the same container. For more information, see "[Example workflow](#example-workflow)."
18+
19+
### Dependencies
20+
21+
You may have difficulty running {% data variables.product.prodname_code_scanning %} if the container you're using is missing certain dependencies (for example, Git must be installed and added to the PATH variable). If you encounter dependency issues, review the list of software typically included on {% data variables.product.prodname_dotcom %}'s virtual environments. For more information, see the version-specific `readme` files in these locations:
22+
23+
* Linux: https://github.com/actions/virtual-environments/tree/main/images/linux
24+
* MacOS: https://github.com/actions/virtual-environments/tree/main/images/macos
25+
* Windows: https://github.com/actions/virtual-environments/tree/main/images/win
26+
27+
### Example workflow
28+
29+
This sample workflow uses {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_codeql %} analysis in a containerized environment. The value of `container.image` identifies the container to use. In this example the image is named `codeql-container`, with a tag of `f0f91db`. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idcontainer)."
30+
31+
``` yaml
32+
name: "{% data variables.product.prodname_codeql %}"
33+
34+
on:
35+
push:
36+
branches: [main]
37+
pull_request:
38+
branches: [main]
39+
schedule:
40+
- cron: '0 0 * * 0'
41+
42+
jobs:
43+
analyze:
44+
name: Analyze
45+
runs-on: ubuntu-latest
46+
47+
strategy:
48+
fail-fast: false
49+
matrix:
50+
language: [java]
51+
52+
# Specify the container in which actions will run
53+
container:
54+
image: codeql-container:f0f91db
55+
56+
steps:
57+
- name: Checkout repository
58+
uses: actions/checkout@v2
59+
- name: Initialize {% data variables.product.prodname_codeql %}
60+
uses: github/codeql-action/init@v1
61+
with:
62+
languages: {% raw %}${{ matrix.language }}{% endraw %}
63+
- name: Build
64+
run: |
65+
./configure
66+
make
67+
- name: Perform {% data variables.product.prodname_codeql %} Analysis
68+
uses: github/codeql-action/analyze@v1
69+
```

content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,4 @@ If the `analyze` command for the {% data variables.product.prodname_codeql_runne
5050
5151
{% endnote %}
5252
53-
1. The code is built in a container or on a separate machine. If you use a containerized build or if you outsource the build to another machine, make sure to run the {% data variables.product.prodname_codeql_runner %} in the container or on the machine where your build task takes place.
53+
1. The code is built in a container or on a separate machine. If you use a containerized build or if you outsource the build to another machine, make sure to run the {% data variables.product.prodname_codeql_runner %} in the container or on the machine where your build task takes place. For more information, see "[Running CodeQL code scanning in a container](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container)."

content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,11 @@ For more information, see the workflow extract in "[Automatic build for a compil
6060
1. Your {% data variables.product.prodname_code_scanning %} workflow is analyzing a compiled language (C, C++, C#, or Java), but the code was not compiled. By default, the {% data variables.product.prodname_codeql %} analysis workflow contains an `autobuild` step, however, this step represents a best effort process, and may not succeed in building your code, depending on your specific build environment. Compilation may also fail if you have removed the `autobuild` step and did not include build steps manually. For more information about specifying build steps, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages#adding-build-steps-for-a-compiled-language)."
6161
1. Your workflow is analyzing a compiled language (C, C++, C#, or Java), but portions of your build are cached to improve performance (most likely to occur with build systems like Gradle or Bazel). Since {% data variables.product.prodname_codeql %} observes the activity of the compiler to understand the data flows in a repository, {% data variables.product.prodname_codeql %} requires a complete build to take place in order to perform analysis.
6262
1. Your workflow is analyzing a compiled language (C, C++, C#, or Java), but compilation does not occur between the `init` and `analyze` steps in the workflow. {% data variables.product.prodname_codeql %} requires that your build happens in between these two steps in order to observe the activity of the compiler and perform analysis.
63-
1. Your compiled code (in C, C++, C#, or Java) was compiled successfully, but {% data variables.product.prodname_codeql %} was unable to detect the compiler invocations. The most common causes are certain configuration options like running your build process in a container, if you're building using a distributed build system external to {% data variables.product.prodname_actions %} using a daemon process, or if {% data variables.product.prodname_codeql %} isn't aware of the specific compiler you are using.
63+
1. Your compiled code (in C, C++, C#, or Java) was compiled successfully, but {% data variables.product.prodname_codeql %} was unable to detect the compiler invocations. The most common causes are:
64+
65+
* Running your build process in a separate container to {% data variables.product.prodname_codeql %}. For more information, see "[Running CodeQL code scanning in a container](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container)."
66+
* Building using a distributed build system external to GitHub Actions, using a daemon process.
67+
* {% data variables.product.prodname_codeql %} isn't aware of the specific compiler you are using.
6468

6569
For C# projects using either `dotnet build` or `msbuild` which target .NET Core 2, you should specify `/p:UseSharedCompilation=false` in your workflow's `run` step, when you build your code. The `UseSharedCompilation` flag isn't necessary for .NET Core 3.0 and later.
6670

content/github/site-policy/github-sensitive-data-removal-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ These guidelines are designed to make the processing of requests to remove sensi
7575

7676
### How to Submit Your Request
7777

78-
You can submit your request to remove sensitive data via our [contact form](https://support.github.com/contact). Please include a plain-text version of your request in the body of your message. Sending your request in an attachment may result in processing delays.
78+
You can submit your request to remove sensitive data via our [contact form](https://support.github.com/contact?tags=docs-sensitive-data). Please include a plain-text version of your request in the body of your message. Sending your request in an attachment may result in processing delays.
7979

8080
### Disputes
8181

content/github/site-policy/github-trademark-policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ When we receive reports of trademark policy violations from holders of federal o
2222

2323
### How Do I Report a Trademark Policy Violation?
2424

25-
Holders of registered trademarks can report possible trademark policy violations to GitHub via our [contact form](https://support.github.com/contact). Please submit trademark-related requests using your company email address and include all the information requested below to help expedite our response. Also be sure to clearly describe to us why the account may cause confusion with your mark or how the account may dilute or tarnish your mark.
25+
Holders of registered trademarks can report possible trademark policy violations to GitHub via our [contact form](https://support.github.com/contact?tags=docs-trademark). Please submit trademark-related requests using your company email address and include all the information requested below to help expedite our response. Also be sure to clearly describe to us why the account may cause confusion with your mark or how the account may dilute or tarnish your mark.
2626

2727
### What Information is Required When Reporting Trademark Policy Violations?
2828

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
- **Job matrix** - A job matrix can generate a maximum of 256 jobs per workflow run. This limit also applies to self-hosted runners.
1+
A job matrix can generate a maximum of 256 jobs per workflow run. This limit also applies to self-hosted runners.

0 commit comments

Comments
 (0)