You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/ISSUE_TEMPLATE/improve-existing-docs.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ labels:
7
7
assignees: ''
8
8
---
9
9
<!--
10
-
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
10
+
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.
11
11
-->
12
12
13
13
<!--
14
14
For questions, ask in Discussions: https://github.com/github/docs/discussions
15
15
16
-
Before you file an issue read the:
16
+
Before you file an issue read the:
17
17
- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
Copy file name to clipboardexpand all lines: .github/ISSUE_TEMPLATE/improve-the-site.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ assignees: ''
7
7
---
8
8
9
9
<!--
10
-
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
10
+
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.
11
11
-->
12
12
13
13
<!--
14
14
For questions, ask in Discussions: https://github.com/github/docs/discussions
15
15
16
-
Before you file an issue read the:
16
+
Before you file an issue read the:
17
17
- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
SLACK_MESSAGE: The last Algolia workflow run for ${{github.repository}} failed. See https://github.com/github/docs-internal/actions?query=workflow%3AAlgolia
40
+
SLACK_MESSAGE: The last Algolia workflow run for ${{github.repository}} failed. Search actions for `workflow:Algolia`
Some octicons are missing from the project's current version of the `octicons` gem. Because this project is being replaced soon and updating `octicons` would require [significant changes](https://github.com/github/docs-internal/issues/6250#issuecomment-339730405), new octicons should be added manually as needed, via the following process:
5
-
6
-
#### How to add
7
-
8
-
1. Locate the missing octicon `.svg` in [primer/octions](https://github.com/primer/octicons/tree/master/lib/svg) and download it to your local `app/assets/images/octions` folder
9
-
1. Add a line to `app/assets/stylesheets/shared/_octicons.scss` for the new octicon, like so:
@@ -73,7 +73,7 @@ When prompted for a username and password, make sure you use an account that has
73
73
74
74
{% tip %}
75
75
76
-
**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/using-git/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail.
76
+
**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/using-git/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail.
Copy file name to clipboardexpand all lines: content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md
+15-15
Original file line number
Diff line number
Diff line change
@@ -44,11 +44,11 @@ Scanning code when someone pushes a change, and whenever a pull request is creat
44
44
45
45
#### Scanning on push
46
46
47
-
By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)."
47
+
By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)."
48
48
49
49
#### Scanning pull requests
50
50
51
-
The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% if currentVersion ver_gt "enterprise-server@2.21" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %}
51
+
The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% if currentVersion ver_gt "enterprise-server@2.21" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %}
52
52
53
53
For more information about the `pull_request` event, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)."
54
54
@@ -148,14 +148,14 @@ jobs:
148
148
matrix:
149
149
language: ['javascript', 'python']
150
150
```
151
-
151
+
152
152
If your workflow does not contain a matrix called `language`, then {% data variables.product.prodname_codeql %} is configured to run analysis sequentially. If you don't specify languages in the workflow, {% data variables.product.prodname_codeql %} automatically detects, and attempts to analyze, any supported languages in the repository. If you want to choose which languages to analyze, without using a matrix, you can use the `languages` parameter under the `init` action.
153
153
154
154
```yaml
155
155
- uses: github/codeql-action/init@v1
156
156
with:
157
157
languages: cpp, csharp, python
158
-
```
158
+
```
159
159
{% if currentVersion == "free-pro-team@latest" %}
160
160
### Analyzing Python dependencies
161
161
@@ -183,7 +183,7 @@ jobs:
183
183
- name: Install dependencies
184
184
run: |
185
185
python -m pip install --upgrade pip
186
-
if [ -f requirements.txt ];
186
+
if [ -f requirements.txt ];
187
187
then pip install -r requirements.txt;
188
188
fi
189
189
# Set the `CODEQL-PYTHON` environment variable to the Python executable
@@ -193,10 +193,10 @@ jobs:
193
193
uses: github/codeql-action/init@v1
194
194
with:
195
195
languages: python
196
-
# Override the default behavior so that the action doesn't attempt
196
+
# Override the default behavior so that the action doesn't attempt
197
197
# to auto-install Python dependencies
198
198
setup-python-dependencies: false
199
-
```
199
+
```
200
200
{% endif %}
201
201
202
202
### Running additional queries
@@ -239,7 +239,7 @@ In the workflow file, use the `config-file` parameter of the `init` action to sp
239
239
```
240
240
241
241
The configuration file can be located within the local repository, or in a public, remote repository. For remote repositories, you can use the _owner/repository/file.yml@branch_ syntax. The settings in the file are written in YAML format.
242
-
242
+
243
243
#### Specifying additional queries
244
244
245
245
You specify additional queries in a `queries` array. Each element of the array contains a `uses` parameter with a value that identifies a single query file, a directory containing query files, or a query suite definition file.
@@ -265,15 +265,15 @@ For the interpreted languages that {% data variables.product.prodname_codeql %}
265
265
266
266
``` yaml
267
267
paths:
268
-
- src
269
-
paths-ignore:
268
+
- src
269
+
paths-ignore:
270
270
- src/node_modules
271
271
- '**/*.test.js'
272
272
```
273
273
274
274
{% note %}
275
275
276
-
**Note**:
276
+
**Note**:
277
277
278
278
* The `paths` and `paths-ignore` keywords, used in the context of the {% data variables.product.prodname_code_scanning %} configuration file, should not be confused with the same keywords when used for `on.<push|pull_request>.paths` in a workflow. When they are used to modify `on.<push|pull_request>` in a workflow, they determine whether the actions will be run when someone modifies code in the specified directories. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)."
279
279
* `**` characters can only be at the start or end of a line, or surrounded by slashes, and you can't mix `**` and other characters. For example, `foo/**`, `**/foo`, and `foo/**/bar` are all allowed syntax, but `**foo` isn't. However you can use single stars along with other characters, as shown in the example. You'll need to quote anything that contains a `*` character.
@@ -298,7 +298,7 @@ You can quickly analyze small portions of a monorepo when you modify code in spe
298
298
299
299
If your workflow for {% data variables.product.prodname_code_scanning %} accesses a private repository, other than the repository that contains the workflow, you'll need to configure Git to authenticate with a personal access token. Define the secret in the runner environment by using `jobs.<job_id>.steps.env` in your workflow before any {% data variables.product.prodname_codeql %} actions. For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)" and "[Creating and storing encrypted secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)."
300
300
301
-
For example, the following configuration has Git replace the full URLs to the `github/foo`, `github/bar`, and `github/baz` repositories on {% data variables.product.prodname_dotcom_the_website %} with URLs that include the personal access token that you store in the `ACCESS_TOKEN` environment variable.
301
+
For example, the following configuration has Git replace the full URLs to the `ghost/foo`, `ghost/bar`, and `ghost/baz` repositories on {% data variables.product.prodname_dotcom_the_website %} with URLs that include the personal access token that you store in the `ACCESS_TOKEN` environment variable.
0 commit comments