Skip to content

Commit da1427f

Browse files
committed
Merge branch 'main' of github.com:github/docs-internal into build-changelog
2 parents caf4add + c137902 commit da1427f

44 files changed

Lines changed: 34943 additions & 36158 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/allowed-actions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ module.exports = [
2424
'lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8',
2525
'pascalgn/automerge-action@c9bd182',
2626
'peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326',
27-
'peter-evans/create-or-update-project-card@80140aaeb9730972a83c626031250621fe8f6670',
27+
'peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd',
2828
'peter-evans/create-pull-request@938e6aea6f8dbdaced2064e948cb806c77fe87b8',
2929
'rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9',
3030
'rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e',

.github/workflows/check-all-english-links.yml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ jobs:
1919
- name: Run script
2020
run: |
2121
script/check-english-links.js > broken_links.md
22-
echo -e '\ncc @github/docs-content'>> broken_links.md
2322
- if: ${{ failure() }}
2423
name: Get title for issue
2524
id: check
@@ -28,7 +27,7 @@ jobs:
2827
name: Close previous report
2928
uses: lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8
3029
with:
31-
query: 'label:"broken+link+report"'
30+
query: 'label:"broken link report"'
3231
token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
3332
- if: ${{ failure() }}
3433
name: Create issue from file
@@ -40,11 +39,10 @@ jobs:
4039
content-filepath: ./broken_links.md
4140
labels: broken link report
4241
- if: ${{ failure() }}
43-
name: Add issue to FR project board
44-
uses: peter-evans/create-or-update-project-card@80140aaeb9730972a83c626031250621fe8f6670
42+
name: Add comment to issue
43+
uses: peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd
4544
with:
46-
project-repository: 'github'
47-
project-number: '1367'
48-
column-name: 'Docs-content FR issues'
45+
body: |
46+
cc @github/docs-content
4947
issue-number: ${{ steps.broken-link-report.outputs.issue-number }}
5048
token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}

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

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,32 @@ The default {% data variables.product.prodname_codeql_workflow %} uses the `pull
5252

5353
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)."
5454

55+
#### Avoiding unnecessary scans of pull requests
56+
57+
You might want to avoid a code scan being triggered on specific pull requests targeted against the default branch, irrespective of which files have been changed. You can configure this by specifying `on:pull_request:paths-ignore` or `on:pull_request:paths` in the {% data variables.product.prodname_code_scanning %} workflow. For example, if the only changes in a pull request are to files with the file extensions `.md` or `.txt` you can use the following `paths-ignore` array.
58+
59+
``` yaml
60+
on:
61+
push:
62+
branches: [main, protected]
63+
pull_request:
64+
branches: [main]
65+
paths-ignore:
66+
- '**/*.md'
67+
- '**/*.txt'
68+
```
69+
70+
{% note %}
71+
72+
**Notes**
73+
74+
* `on:pull_request:paths-ignore` and `on:pull_request:paths` set conditions that determine whether the actions in the workflow will run on a pull request. They don't determine what files will be analyzed when the actions _are_ run. When a pull request contains any files that are not matched by `on:pull_request:paths-ignore` or `on:pull_request:paths`, the workflow runs the actions and scans all of the files changed in the pull request, including those matched by `on:pull_request:paths-ignore` or `on:pull_request:paths`, unless the files have been excluded. For information on how to exclude files from analysis, see "[Specifying directories to scan](#specifying-directories-to-scan)."
75+
* For {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} workflow files, don't use the `paths-ignore` or `paths` keywords with the `on:push` event as this is likely to cause missing analyses. For accurate results, {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} needs to be able to compare new changes with the analysis of the previous commit.
76+
77+
{% endnote %}
78+
79+
For more information about using `on:pull_request:paths-ignore` and `on:pull_request:paths` to determine when a workflow will run for a pull request, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)."
80+
5581
#### Scanning on a schedule
5682

5783
If you use the default {% data variables.product.prodname_codeql_workflow %}, the workflow will scan the code in your repository once a week, in addition to the scans triggered by events. To adjust this schedule, edit the `cron` value in the workflow. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onschedule)."
@@ -235,13 +261,13 @@ If you only want to run custom queries, you can disable the default security que
235261

236262
#### Specifying directories to scan
237263

238-
For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from scans by adding a `paths-ignore` array.
264+
For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python and JavaScript/TypeScript), you can restrict {% data variables.product.prodname_code_scanning %} to files in specific directories by adding a `paths` array to the configuration file. You can exclude the files in specific directories from analysis by adding a `paths-ignore` array.
239265

240266
``` yaml
241-
paths:
267+
paths:
242268
- src
243269
paths-ignore:
244-
- node_modules
270+
- src/node_modules
245271
- '**/*.test.js'
246272
```
247273

@@ -254,7 +280,7 @@ paths-ignore:
254280

255281
{% endnote %}
256282

257-
For C/C++, C#, and Java, if you want to limit {% data variables.product.prodname_code_scanning %} to specific directories in your project, you must specify appropriate build steps in the workflow. The commands you need to use to exclude a directory from the build will depend on your build system. For more information, 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)."
283+
For compiled languages, if you want to limit {% data variables.product.prodname_code_scanning %} to specific directories in your project, you must specify appropriate build steps in the workflow. The commands you need to use to exclude a directory from the build will depend on your build system. For more information, 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)."
258284

259285
You can quickly analyze small portions of a monorepo when you modify code in specific directories. You'll need to both exclude directories in your build steps and use the `paths-ignore` and `paths` keywords for [`on.<push|pull_request>`](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths) in your workflow.
260286

content/github/managing-subscriptions-and-notifications-on-github/viewing-your-subscriptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ To see an overview of your repository subscriptions, see "[Reviewing repositorie
4141
{% endtip %}
4242
{% endif %}
4343

44-
Many people forget about repositories that they've chosen to watch in the past. From the "Watched repositories" page you can quickly unwatch repositories. For more information on ways to unsubscribe, see "[Unwatch recommendations](https://github.blog/changelog/2020-11-10-unwatch-recommendations/)" on {% data variables.product.prodname_blog %} and "[Managing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)." You can also create a triage worflow to help with the notifications you receive. For guidance on triage workflows, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)."
44+
Many people forget about repositories that they've chosen to watch in the past. From the "Watched repositories" page you can quickly unwatch repositories. For more information on ways to unsubscribe, see "[Unwatch recommendations](https://github.blog/changelog/2020-11-10-unwatch-recommendations/)" on {% data variables.product.prodname_blog %} and "[Managing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)." You can also create a triage workflow to help with the notifications you receive. For guidance on triage workflows, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)."
4545

4646
### Reviewing all of your subscriptions
4747

content/github/managing-your-work-on-github/about-labels.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

content/github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

content/github/managing-your-work-on-github/creating-a-label.md

Lines changed: 0 additions & 35 deletions
This file was deleted.

content/github/managing-your-work-on-github/deleting-a-label.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

content/github/managing-your-work-on-github/editing-a-label.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

content/github/managing-your-work-on-github/index.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ versions:
1414

1515
### Table of Contents
1616

17-
{% topic_link_in_list /managing-your-work-with-issues %}
17+
{% topic_link_in_list /managing-your-work-with-issues-and-pull-requests %}
1818
{% link_in_list /about-issues %}
1919
{% link_in_list /creating-an-issue %}
2020
<!-- if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.15" -->
@@ -27,6 +27,7 @@ versions:
2727
{% link_in_list /pinning-an-issue-to-your-repository %}
2828
<!-- endif -->
2929
{% link_in_list /creating-a-permanent-link-to-a-code-snippet %}
30+
{% link_in_list /managing-labels %}
3031
{% link_in_list /about-task-lists %}
3132
{% link_in_list /about-automation-for-issues-and-pull-requests-with-query-parameters %}
3233
{% link_in_list /file-attachments-on-issues-and-pull-requests %}
@@ -35,12 +36,6 @@ versions:
3536
{% link_in_list /disabling-issues %}
3637
{% link_in_list /linking-a-pull-request-to-an-issue %}
3738
{% link_in_list /about-duplicate-issues-and-pull-requests %}
38-
{% topic_link_in_list /labeling-issues-and-pull-requests %}
39-
{% link_in_list /about-labels %}
40-
{% link_in_list /creating-a-label %}
41-
{% link_in_list /applying-labels-to-issues-and-pull-requests %}
42-
{% link_in_list /editing-a-label %}
43-
{% link_in_list /deleting-a-label %}
4439
{% topic_link_in_list /managing-project-boards %}
4540
{% link_in_list /about-project-boards %}
4641
{% link_in_list /creating-a-project-board %}

0 commit comments

Comments
 (0)