Skip to content

Commit d04f425

Browse files
rsesersese
authored
Merge branch 'main' into mgriffin/answered-discussion
2 parents 18ce9bd + ca6926e commit d04f425

File tree

82 files changed

+2167
-525
lines changed

Some content is hidden

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

82 files changed

+2167
-525
lines changed

‎.github/CODEOWNERS

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,9 @@ src/ghes-releases/lib/enterprise-dates.json @github/docs-content-enterprise
1212

1313
# Requires review of #actions-oidc-integration, docs-engineering/issues/1506
1414
content/actions/deployment/security-hardening-your-deployments/** @github/oidc
15+
16+
# Temporary, so @lecoursen can copy any changes to the audit log reference
17+
# to the JSON file that will soon be used to auto-generate this content
18+
/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md @lecoursen
19+
/content/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/audit-log-events-for-your-organization.md @lecoursen
20+
/content/authentication/keeping-your-account-and-data-secure/security-log-events.md @lecoursen

‎.github/workflows/test.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,18 @@ jobs:
5353
{ name: 'github-apps', path: 'src/github-apps/tests', },
5454
{ name: 'graphql', path: 'src/graphql/tests', },
5555
{ name: 'landings', path: 'src/landings/tests', },
56-
// { name: 'learning-track', path: 'src/learning-track/tests', },
56+
{ name: 'learning-track', path: 'src/learning-track/tests', },
5757
{ name: 'linting', path: 'src/content-linter/tests', },
5858
{ name: 'observability', path: 'src/observability/tests' },
5959
{ name: 'pageinfo', path: 'src/pageinfo/tests', },
6060
{ name: 'redirects', path: 'src/redirects/tests', },
61+
{ name: 'release-notes', path: 'src/release-notes/tests', },
6162
{ name: 'rendering', path: 'tests/rendering', },
6263
{ name: 'rendering-fixtures', path: 'tests/rendering-fixtures', },
6364
{ name: 'rest', path: 'src/rest/tests', },
6465
{ name: 'routing', path: 'tests/routing', },
6566
{ name: 'search', path: 'src/search/tests', },
67+
{ name: 'secret-scanning', path: 'src/secret-scanning/tests',},
6668
{ name: 'shielding', path: 'src/shielding/tests', },
6769
context.payload.repository.full_name === 'github/docs-internal' &&
6870
{ name: 'languages', path: 'src/languages/tests', },

‎content/apps/creating-github-apps/writing-code-for-a-github-app/building-ci-checks-with-a-github-app.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,6 @@ class GHAapp < Sinatra::Application
319319
# this request is an attack, and you should reject it. GitHub uses the HMAC
320320
# hexdigest to compute the signature. The `X-HUB-Signature` looks something
321321
# like this: 'sha1=123456'.
322-
# See https://developer.github.com/webhooks/securing/ for details.
323322
def verify_webhook_signature
324323
their_signature_header = request.env['HTTP_X_HUB_SIGNATURE'] || 'sha1='
325324
method, their_digest = their_signature_header.split('=')
@@ -571,7 +570,7 @@ You can test that the server is listening to your app by triggering an event for
571570

572571
1. Create a new repository to use for testing your tutorial code. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository)."
573572
1. Install the {% data variables.product.prodname_github_app %} on the repository you just created. For more information, see "[AUTOTITLE](/apps/using-github-apps/installing-your-own-github-app#installing-your-own-github-app)." During the installation process, choose **Only select repositories**, and select the repository you created in the previous step.
574-
2. After you click **Install**, look at the output in the terminal tab where you're running `server.rb`. You should see something like this:
573+
1. After you click **Install**, look at the output in the terminal tab where you're running `server.rb`. You should see something like this:
575574

576575
```shell
577576
> D, [2023-06-08T15:45:43.773077 #30488] DEBUG -- : ---- received event installation
@@ -1147,7 +1146,7 @@ To push to a repository, your app must have write permissions for "Contents" in
11471146
To commit files, Git must know which username and email address to associate with the commit. Next you'll add environment variables to store the name and email address that your app will use when it makes Git commits.
11481147
11491148
1. Open the `.env` file you created earlier in this tutorial.
1150-
2. Add the following environment variables to your `.env` file. Replace `APP_NAME` with the name of your app, and `EMAIL_ADDRESS` with any email you'd like to use for this example.
1149+
1. Add the following environment variables to your `.env` file. Replace `APP_NAME` with the name of your app, and `EMAIL_ADDRESS` with any email you'd like to use for this example.
11511150
11521151
```shell copy
11531152
GITHUB_APP_USER_NAME="APP_NAME"
@@ -1542,7 +1541,6 @@ class GHAapp < Sinatra::Application
15421541
# this request is an attack, and you should reject it. GitHub uses the HMAC
15431542
# hexdigest to compute the signature. The `X-HUB-Signature` looks something
15441543
# like this: 'sha1=123456'.
1545-
# See https://developer.github.com/webhooks/securing/ for details.
15461544
def verify_webhook_signature
15471545
their_signature_header = request.env['HTTP_X_HUB_SIGNATURE'] || 'sha1='
15481546
method, their_digest = their_signature_header.split('=')

‎content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ redirect_from:
2121

2222
## About dependency review
2323

24-
{% data reusables.dependency-review.feature-overview %}
24+
{% data reusables.dependency-review.feature-overview %}
2525

2626
If a pull request targets your repository's default branch and contains changes to package manifests or lock files, you can display a dependency review to see what has changed. The dependency review includes details of changes to indirect dependencies in lock files, and it tells you if any of the added or updated dependencies contain known vulnerabilities.
2727

@@ -58,12 +58,44 @@ You can use the {% data variables.dependency-review.action_name %} in your repos
5858

5959
By default, the {% data variables.dependency-review.action_name %} check will fail if it discovers any vulnerable packages. A failed check blocks a pull request from being merged when the repository owner requires the dependency review check to pass. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging)."
6060

61-
{% ifversion fpt or ghec or ghes %}
62-
The action uses the Dependency Review REST API to get the diff of dependency changes between the base commit and head commit. You can use the Dependency Review API to get the diff of dependency changes, including vulnerability data, between any two commits on a repository. For more information, see "[AUTOTITLE](/rest/dependency-graph#dependency-review)."
61+
{% ifversion fpt or ghec or ghes %}The action uses the dependency review REST API to get the diff of dependency changes between the base commit and head commit. You can use the dependency review API to get the diff of dependency changes, including vulnerability data, between any two commits on a repository. For more information, see "[AUTOTITLE](/rest/dependency-graph#dependency-review)."{% endif %}{% ifversion dependency-review-submission-api %} The action also considers dependencies submitted via the dependency submission API. For more information about the dependency submission API, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api)."
62+
63+
{% data reusables.dependency-review.works-with-submission-api-beta %}
64+
6365
{% endif %}
6466

6567
{% ifversion dependency-review-action-configuration %}
6668
You can configure the {% data variables.dependency-review.action_name %} to better suit your needs. For example, you can specify the severity level that will make the action fail{% ifversion dependency-review-action-licenses %}, or set an allow or deny list for licenses to scan{% endif %}. For more information, see "[AUTOTITLE](/code-security/supply-chain-security/understanding-your-software-supply-chain/configuring-dependency-review#configuring-the-dependency-review-github-action)."
6769
{% endif %}
6870

6971
{% endif %}
72+
73+
{% ifversion dependency-review-submission-api %}
74+
75+
## Best practices for using the dependency review API and the dependency submission API together
76+
77+
The dependency review API and the {% data variables.dependency-review.action_name %} both work by comparing dependency changes in a pull request with the state of your dependencies in the head commit of your target branch, which is usually your default branch.
78+
79+
If your repository only depends on statically defined dependencies in one of {% data variables.product.prodname_dotcom %}’s supported ecosystems, the dependency review API and the {% data variables.dependency-review.action_name %} work consistently.
80+
81+
However, you may want your dependencies to be scanned during a build and then uploaded to the dependency submission API. In this case, there are some best practices you should follow to ensure that you don’t introduce a race condition when running the processes for the dependency review API and the dependency submission API, since it could result in missing data.
82+
83+
The best practices you should take will depend on whether you use {% data variables.product.prodname_actions %} to access the dependency submission API and the dependency review API, or whether you use direct API access.
84+
85+
### Using GitHub Actions to access the dependency submission API and the dependency review API
86+
87+
If you use {% data variables.product.prodname_actions %} to access the dependency submission API or the dependency review API:
88+
* Make sure you run all of your dependency submission actions in the same {% data variables.product.prodname_actions %} workflow as your {% data variables.dependency-review.action_name %}. This will give you control over the order of execution, and it will ensure that dependency review will always work.
89+
* If you do choose to run the {% data variables.dependency-review.action_name %} separately, for instance, as a required workflow, you should:
90+
+ Set `retry-on-snapshot-warnings` to `true`.
91+
+ Set `retry-on-snapshot-warnings-timeout` to slightly exceed the typical run time (in seconds) of your longest-running dependency submission action.
92+
93+
### Using direct API access to the dependency submission API and the dependency review API
94+
95+
If you don’t use {% data variables.product.prodname_actions %}, and your code relies on direct access to the dependency submission API and the dependency review API:
96+
* Make sure you run the code that calls the dependency submission API first, and then run the code that calls the dependency review API afterwards.
97+
* If you do choose to run the code for the dependency submission API and the dependency review API in parallel, you should implement a retry logic and note the following:
98+
+ When there are snapshots missing for either side of the comparison, you will see an explanation for that in the `x-github-dependency-graph-snapshot-warnings` header (as a base64-encoded string). Therefore, if the header is non-empty, you should consider retrying.
99+
+ Implement a retry logic with exponential backoff retries.
100+
+ Implement a reasonable number of retries to account for the typical runtime of your dependency submission code.
101+
{% endif %}

‎content/codespaces/managing-codespaces-for-your-organization/listing-the-codespaces-in-your-organization.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,14 @@ For information on how to see the current total {% data variables.product.prodna
2626
To list all of the current codespaces for a specified organization, use the following command.
2727

2828
```shell copy
29-
gh codespace list --org ORGANIZATION
29+
gh codespace list --org ORGANIZATION
3030
```
3131

3232
This command returns a list that includes the following information for each codespace:
33-
- The name and display name
34-
- The user who created the codespace
35-
- The repository and branch
36-
- The current state of the codespace
33+
- The name and display name
34+
- The user who created the codespace
35+
- The repository and branch
36+
- The current state of the codespace
3737

3838
To list all of the current codespaces for an organization that were created by a specific user, use the following command.
3939

‎content/contributing/setting-up-your-environment-to-work-on-github-docs/creating-a-local-environment.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ The [`script/bookmarklets`](https://github.com/github/docs/tree/main/script/book
7171

7272
### Enabling different languages
7373

74-
By default, the local server does not run with all supported languages enabled. If you need to run a local server with a particular language, you can temporarily edit the `start` script in `package.json` and update the `ENABLED_LANGUAGES` variable.
74+
By default, the local server does not run with all supported languages enabled. If you need to run a local server with a particular language, you can temporarily edit the `start` script in `package.json` and update the `ENABLED_LANGUAGES` variable.
7575

76-
For example, to enable Japanese and Portuguese in addition to English, you can edit `package.json` and set `ENABLED_LANGUAGES='en,ja,pt'` in the `start` script. Then restart the server for the change to take effect.
76+
For example, to enable Japanese and Portuguese in addition to English, you can edit `package.json` and set `ENABLED_LANGUAGES='en,ja,pt'` in the `start` script. Then restart the server for the change to take effect.
7777

7878
{% note %}
7979

@@ -83,10 +83,9 @@ For example, to enable Japanese and Portuguese in addition to English, you can e
8383

8484
The supported language codes are defined in [`src/languages/lib/languages.js`](https://github.com/github/docs/blob/main/src/languages/lib/languages.js).
8585

86-
8786
## Using {% data variables.product.prodname_github_codespaces %}
8887

89-
As an alternative to running {% data variables.product.prodname_docs %} locally, you can use {% data variables.product.prodname_github_codespaces %}. {% data variables.product.prodname_github_codespaces %} enable you to edit, preview, and test your changes directly from your browser.
88+
As an alternative to running {% data variables.product.prodname_docs %} locally, you can use {% data variables.product.prodname_github_codespaces %}. {% data variables.product.prodname_github_codespaces %} enable you to edit, preview, and test your changes directly from your browser.
9089

9190
For more information about using a codespace for working on {% data variables.product.company_short %} documentation, see "[AUTOTITLE](/contributing/setting-up-your-environment-to-work-on-github-docs/working-on-github-docs-in-a-codespace)."
9291

@@ -98,4 +97,4 @@ For more information about using a codespace for working on {% data variables.pr
9897
- [Middleware](https://github.com/github/docs/blob/main/middleware/README.md)
9998
- [Scripts](https://github.com/github/docs/blob/main/script/README.md)
10099
- [Styles](https://github.com/github/docs/blob/main/stylesheets/README.md)
101-
- [Tests](https://github.com/github/docs/blob/main/tests/README.md)
100+
- [Tests](https://github.com/github/docs/blob/main/tests/README.md)

‎content/desktop/contributing-and-collaborating-using-github-desktop/adding-and-cloning-repositories/cloning-a-repository-from-github-to-github-desktop.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ shortTitle: Clone a GitHub repo
2121

2222
![Screenshot of the "URL" tab of the "Clone a Repository" window. Next to the "Local Path" field, a button, labeled "Choose", is highlighted with an orange outline.](/assets/images/help/desktop/clone-choose-button-url-mac.png)
2323

24-
{% note %}
24+
{% note %}
2525

26-
**Note:** If the repository is configured to use LFS, you will be prompted to initialize {% data variables.large_files.product_name_short %}.
26+
**Note:** If the repository is configured to use LFS, you will be prompted to initialize {% data variables.large_files.product_name_short %}.
2727

28-
{% endnote %}
28+
{% endnote %}
2929

3030
1. Click **Clone**.

‎content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Once you're satisfied with the changes you've chosen to include in your commit,
120120
- To move your changes, click **switch branches**.
121121
- To commit your changes to the protected branch, click **Commit to BRANCH**.
122122

123-
For more information about protected branches, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)."
123+
For more information about protected branches, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)."
124124
{% data reusables.desktop.push-origin %}
125125

126126
1. If you have a pull request based off the branch you are working on, {% data variables.product.prodname_desktop %} will display the status of the checks that have run for the pull request next to the "Current Branch" section of the repository bar. For more information about checks, see "[AUTOTITLE](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop)."

‎content/desktop/contributing-and-collaborating-using-github-desktop/managing-commits/reordering-commits-in-github-desktop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ When you reorder commits, you may see one of the following notifications or erro
3636
- A message states that there are merge conflicts that you must resolve before the application can continue reordering commits on your branch.
3737
1. Click **View conflicts**.
3838

39-
![Screenshot of a notification about conflicts. At the end of the message, a link, labeled "View commits", is highlighted with an orange outline.](/assets/images/help/desktop/reorder-resolve-conflicts.png)
39+
![Screenshot of a notification about conflicts. At the end of the message, a link, labeled "View commits", is highlighted with an orange outline.](/assets/images/help/desktop/reorder-resolve-conflicts.png)
4040
{% data reusables.desktop.resolve-merge-conflicts %}
4141

4242
1. When all conflicts are resolved, you can reorder your commits.

‎content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github-in-github-desktop.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Before you authenticate, {% data reusables.desktop.get-an-account %}
5656

5757
{% data reusables.desktop.sign-in-browser %}
5858

59-
{% data reusables.user-settings.password-authentication-deprecation-desktop %}
59+
{% indented_data_reference reusables.user-settings.password-authentication-deprecation-desktop spaces=3 %}
6060

6161
{% data reusables.desktop.authenticate-in-browser %}
6262
{% data reusables.desktop.2fa-in-browser %}

‎content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/manage-classrooms.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ If your course already has a roster, you can update the students on the roster o
6060

6161
{% note %}
6262

63-
**Note:** {% data reusables.classroom.google-classroom-note %}
63+
**Note:** {% data reusables.classroom.google-classroom-note %}
6464

65-
{% endnote %}
65+
{% endnote %}
6666

6767
1. Provide the student identifiers for your roster.
6868

69-
- To import a roster by uploading a file containing student identifiers, click **Upload a CSV or text file**.
70-
- To create a roster manually, type your student identifiers in the text field.
69+
- To import a roster by uploading a file containing student identifiers, click **Upload a CSV or text file**.
70+
- To create a roster manually, type your student identifiers in the text field.
7171

7272
1. Click **Create roster**.
7373

@@ -80,13 +80,13 @@ Your classroom must have an existing roster to add students to the roster. For m
8080
{% data reusables.classroom.click-students %}
8181
1. To the right of "Classroom roster", click **Update students**. If you have already linked your classroom to an LMS course, then you will see a **Sync from...** button instead.
8282
1. Follow the instructions to add students to the roster.
83-
- To import students from an LMS, your LMS administrator will first need to register your LMS instance and then you will need to connect your LMS course to your classroom. Once connected, you can click the **Sync from...** button. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)."
84-
{% note %}
83+
- To import students from an LMS, your LMS administrator will first need to register your LMS instance and then you will need to connect your LMS course to your classroom. Once connected, you can click the **Sync from...** button. For more information, see "[AUTOTITLE](/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-course-to-a-classroom)."
84+
{% note %}
8585

86-
**Note:** {% data reusables.classroom.google-classroom-note %}
86+
**Note:** {% data reusables.classroom.google-classroom-note %}
8787

88-
{% endnote %}
89-
- To manually add students, under "Manually add students", click **Upload a CSV or text file** or type the identifiers for the students, then click **Add roster entries**.
88+
{% endnote %}
89+
- To manually add students, under "Manually add students", click **Upload a CSV or text file** or type the identifiers for the students, then click **Add roster entries**.
9090

9191
## Renaming a classroom
9292

0 commit comments

Comments
 (0)