Skip to content

Commit f3896e1

Browse files
authored
Merge branch 'main' into 7713-privacy-statement-update-sep-2022
2 parents 16dcf64 + b6a0108 commit f3896e1

File tree

174 files changed

+2754
-771
lines changed

Some content is hidden

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

174 files changed

+2754
-771
lines changed
27.5 KB
Loading

components/lib/get-rest-code-samples.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,12 +86,12 @@ export function getGHExample(operation: Operation, codeSample: CodeSample) {
8686
requestBodyParams = Object.keys(codeSample.request.bodyParameters)
8787
.map((key) => {
8888
if (typeof codeSample.request.bodyParameters[key] === 'string') {
89-
return `-f ${key}='${codeSample.request.bodyParameters[key]}'\n`
89+
return `-f ${key}='${codeSample.request.bodyParameters[key]}' `
9090
} else {
91-
return `-F ${key}=${codeSample.request.bodyParameters[key]}\n`
91+
return `-F ${key}=${codeSample.request.bodyParameters[key]} `
9292
}
9393
})
94-
.join(' ')
94+
.join('\\\n ')
9595
}
9696
const args = [
9797
operation.verb !== 'get' && `--method ${operation.verb.toUpperCase()}`,

content/admin/configuration/configuring-network-settings/configuring-a-hostname.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ topics:
1616
---
1717
If you configure a hostname instead of a hard-coded IP address, you will be able to change the physical hardware that {% data variables.product.product_location %} runs on without affecting users or client software.
1818

19-
The hostname setting in the {% data variables.enterprise.management_console %} should be set to an appropriate fully qualified domain name (FQDN) which is resolvable on the internet or within your internal network. For example, your hostname setting could be `github.companyname.com.` Web and API requests will automatically redirect to the hostname configured in the {% data variables.enterprise.management_console %}. Note that `localhost` is not a valid hostname setting.
19+
The hostname setting in the {% data variables.enterprise.management_console %} should be set to an appropriate fully qualified domain name (FQDN) which is resolvable on the internet or within your internal network. For example, your hostname setting could be `github.companyname.com.` Web and API requests will automatically redirect to the hostname configured in the {% data variables.enterprise.management_console %}. Note that `localhost` is not a valid hostname setting.
20+
21+
Hostnames must be less than 63 characters in length per [Section 2.3.4 of the Domain Names Specification RFC](https://datatracker.ietf.org/doc/html/rfc1035#section-2.3.4).
2022

2123
After you configure a hostname, you can enable subdomain isolation to further increase the security of {% data variables.product.product_location %}. For more information, see "[Enabling subdomain isolation](/enterprise/admin/guides/installation/enabling-subdomain-isolation/)."
2224

content/admin/configuration/configuring-your-enterprise/configuring-email-for-notifications.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,14 @@ settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-all
9090

9191
You can enforce TLS encryption for all incoming SMTP connections, which can help satisfy an ISO-27017 certification requirement.
9292

93+
{%- ifversion ghes = 3.6 %}
94+
{% note %}
95+
96+
**Note**: Enforcement of TLS for SMTP connections is unavailable in {% data variables.product.product_name %} 3.6.0. The feature will be available in an upcoming release.
97+
98+
{% endnote %}
99+
{%- endif %}
100+
93101
{% data reusables.enterprise_site_admin_settings.email-settings %}
94102
1. Under "Authentication," select **Enforce TLS auth (recommended)**.
95103

content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ For more information about the audit log REST API, see "[Enterprise administrati
121121
The query below searches for audit log events created on Jan 1st, 2022 in the `avocado-corp` enterprise, and return the first page with a maximum of 100 items per page using [REST API pagination](/rest/overview/resources-in-the-rest-api#pagination):
122122

123123
```shell
124-
curl -H "Authorization: token <em>TOKEN</em>" \
124+
curl -H "Authorization: Bearer <em>TOKEN</em>" \
125125
--request GET \
126126
"https://api.github.com/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100"
127127
```
@@ -133,7 +133,7 @@ You can specify multiple search phrases, such as `created` and `actor`, by separ
133133
The query below searches for audit log events for pull requests, where the event occurred on or after Jan 1st, 2022 in the `avocado-corp` enterprise, and the action was performed by the `octocat` user:
134134

135135
```shell
136-
curl -H "Authorization: token <em>TOKEN</em>" \
136+
curl -H "Authorization: Bearer <em>TOKEN</em>" \
137137
--request GET \
138138
"https://api.github.com/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat"
139139
```

content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ The Migrations API is currently in a preview period, which means that the endpoi
4444
* Your access token for authentication.
4545
* A [list of the repositories](/free-pro-team@latest/rest/repos#list-organization-repositories) you want to migrate:
4646
```shell
47-
curl -H "Authorization: token <em>GITHUB_ACCESS_TOKEN</em>" \
47+
curl -H "Authorization: Bearer <em>GITHUB_ACCESS_TOKEN</em>" \
4848
-X POST \
4949
-H "Accept: application/vnd.github+json" \
5050
-d'{"lock_repositories":true,"repositories":["<em>orgname</em>/<em>reponame</em>", "<em>orgname</em>/<em>reponame</em>"]}' \
@@ -59,7 +59,7 @@ The Migrations API is currently in a preview period, which means that the endpoi
5959
* Your access token for authentication.
6060
* The unique `id` of the migration:
6161
```shell
62-
curl -H "Authorization: token <em>GITHUB_ACCESS_TOKEN</em>" \
62+
curl -H "Authorization: Bearer <em>GITHUB_ACCESS_TOKEN</em>" \
6363
-H "Accept: application/vnd.github+json" \
6464
https://api.github.com/orgs/<em>orgname</em>/migrations/<em>id</em>
6565
```
@@ -74,7 +74,7 @@ The Migrations API is currently in a preview period, which means that the endpoi
7474
* Your access token for authentication.
7575
* The unique `id` of the migration:
7676
```shell
77-
curl -H "Authorization: token <em>GITHUB_ACCESS_TOKEN</em>" \
77+
curl -H "Authorization: Bearer <em>GITHUB_ACCESS_TOKEN</em>" \
7878
-H "Accept: application/vnd.github+json" \
7979
-L -o migration_archive.tar.gz \
8080
https://api.github.com/orgs/<em>orgname</em>/migrations/<em>id</em>/archive
@@ -84,7 +84,7 @@ The Migrations API is currently in a preview period, which means that the endpoi
8484
* Your access token for authentication.
8585
* The unique `id` of the migration:
8686
```shell
87-
curl -H "Authorization: token <em>GITHUB_ACCESS_TOKEN</em>" \
87+
curl -H "Authorization: Bearer <em>GITHUB_ACCESS_TOKEN</em>" \
8888
-X DELETE \
8989
-H "Accept: application/vnd.github+json" \
9090
https://api.github.com/orgs/<em>orgname</em>/migrations/<em>id</em>/archive

content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ To unlock the repositories on a {% data variables.product.prodname_dotcom_the_we
133133
* The unique `id` of the migration
134134
* The name of the repository to unlock
135135
```shell
136-
curl -H "Authorization: token <em>GITHUB_ACCESS_TOKEN</em>" -X DELETE \
136+
curl -H "Authorization: Bearer <em>GITHUB_ACCESS_TOKEN</em>" -X DELETE \
137137
-H "Accept: application/vnd.github.wyandotte-preview+json" \
138138
https://api.github.com/orgs/<em>orgname</em>/migrations/<em>id</em>/repos/<em>repo_name</em>/lock
139139
```
@@ -142,7 +142,7 @@ curl -H "Authorization: token <em>GITHUB_ACCESS_TOKEN</em>" -X DELETE \
142142

143143
After unlocking the {% data variables.product.prodname_dotcom_the_website %} organization's repositories, you should delete every repository you previously migrated using [the repository delete endpoint](/rest/repos/#delete-a-repository). You'll need your access token for authentication:
144144
```shell
145-
curl -H "Authorization: token <em>GITHUB_ACCESS_TOKEN</em>" -X DELETE \
145+
curl -H "Authorization: Bearer <em>GITHUB_ACCESS_TOKEN</em>" -X DELETE \
146146
https://api.github.com/repos/<em>orgname</em>/<em>repo_name</em>
147147
```
148148

content/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning.md

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ In the following example, the `+` symbol ensures that the specified additional {
359359

360360
## Using a custom configuration file
361361

362-
A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries and to specify which directories to scan during analysis.
362+
A custom configuration file is an alternative way to specify additional {% ifversion codeql-packs %}packs and {% endif %}queries to run. You can also use the file to disable the default queries{% ifversion code-scanning-exclude-queries-from-analysis %}, exclude or include specific queries,{% endif %} and to specify which directories to scan during analysis.
363363

364364
In the workflow file, use the `config-file` parameter of the `init` action to specify the path to the configuration file you want to use. This example loads the configuration file _./.github/codeql/codeql-config.yml_.
365365

@@ -442,6 +442,41 @@ Optionally, you can give each array element a name, as shown in the example conf
442442

443443
If you only want to run custom queries, you can disable the default security queries by using `disable-default-queries: true`.
444444

445+
{% ifversion code-scanning-exclude-queries-from-analysis %}
446+
### Excluding specific queries from analysis
447+
448+
You can add `exclude` and `include` filters to your custom configuration file, to specify the queries you want to exclude or include in the analysis.
449+
450+
This is useful if you want to exclude, for example:
451+
- Specific queries from the default suites (`security`, `security-extended` and `security-and-quality`).
452+
- Specific queries whose results do not interest you.
453+
- All the queries that generate warnings and recommendations.
454+
455+
You can use `exclude` filters similar to those in the configuration file below to exclude queries that you want to remove from the default analysis. In the example of configuration file below, both the `js/redundant-assignment` and the `js/useless-assignment-to-local` queries are excluded from analysis.
456+
457+
```yaml
458+
query-filters:
459+
- exclude:
460+
id: js/redundant-assignment
461+
- exclude:
462+
id: js/useless-assignment-to-local
463+
```
464+
To find the id of a query, you can click the alert in the list of alerts in the Security tab. This opens the alert details page. The `Rule ID` field contains the query id. For more information about the alert details page, see "[About {% data variables.product.prodname_code_scanning %} alerts](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts#about-alert-details)."
465+
466+
{% tip %}
467+
468+
**Tips:**
469+
- The order of the filters is important. The first filter instruction that appears after the instructions about the queries and query packs determines whether the queries are included or excluded by default.
470+
- Subsequent instructions are executed in order and the instructions that appear later in the file take precedence over the earlier instructions.
471+
472+
{% endtip %}
473+
474+
You can find another example illustrating the use of these filters in the "[Example configuration files](#example-configuration-files)" section.
475+
476+
For more information about using `exclude` and `include` filters in your custom configuration file, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/#filtering-the-queries-in-a-query-suite)." For information on the query metadata you can filter on, see "[Metadata for CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/metadata-for-codeql-queries/)."
477+
478+
{% endif %}
479+
445480
### Specifying directories to scan
446481

447482
For the interpreted languages that {% data variables.product.prodname_codeql %} supports (Python{% ifversion fpt or ghes > 3.3 or ghae-issue-5017 %}, Ruby{% endif %} 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.

content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,8 @@ You can display the command-line help for any command using the <nobr>`--help`</
7878
| <nobr>`--command`</nobr> | | Recommended. Use to specify the build command or script that invokes the build process for the codebase. Commands are run from the current folder or, where it is defined, from <nobr>`--source-root`</nobr>. Not needed for Python and JavaScript/TypeScript analysis. |
7979
| <nobr>`--db-cluster`</nobr> | | Optional. Use in multi-language codebases to generate one database for each language specified by <nobr>`--language`</nobr>.
8080
| <nobr>`--no-run-unnecessary-builds`</nobr> | | Recommended. Use to suppress the build command for languages where the {% data variables.product.prodname_codeql_cli %} does not need to monitor the build (for example, Python and JavaScript/TypeScript).
81-
| <nobr>`--source-root`</nobr> | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. |
81+
| <nobr>`--source-root`</nobr> | | Optional. Use if you run the CLI outside the checkout root of the repository. By default, the `database create` command assumes that the current directory is the root directory for the source files, use this option to specify a different location. |{% ifversion fpt or ghec or ghes > 3.2 or ghae %}
82+
| <nobr>`--codescanning-config`</nobr> | | Optional (Advanced). Use if you have a configuration file that specifies how to create the {% data variables.product.prodname_codeql %} databases and what queries to run in later steps. For more information, see "[Using a custom configuration file](/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-a-custom-configuration-file)" and "[database create](https://codeql.github.com/docs/codeql-cli/manual/database-create/#cmdoption-codeql-database-create-codescanning-config)." |{% endif %}
8283

8384
For more information, see [Creating {% data variables.product.prodname_codeql %} databases](https://codeql.github.com/docs/codeql-cli/creating-codeql-databases/) in the documentation for the {% data variables.product.prodname_codeql_cli %}.
8485

content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Troubleshooting creation and deletion of Codespaces
2+
title: Troubleshooting creation and deletion of codespaces
33
intro: 'This article provides troubleshooting steps for common issues you may experience when creating or deleting a codespace, including storage and configuration issues.'
44
product: '{% data reusables.gated-features.codespaces %}'
55
versions:
@@ -16,6 +16,8 @@ shortTitle: Creation and deletion
1616
### No access to create a codespace
1717
{% data variables.product.prodname_codespaces %} are not available for all repositories. If the "Open with Codespaces" button is missing, {% data variables.product.prodname_github_codespaces %} may not be available for that repository. For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces)."
1818

19+
You can't create a codespace for a private repository that is owned by an organization, unless you have write access to the repository or the organization has enabled forking for it.
20+
1921
If you believe your organization has [enabled {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#about-enabling-codespaces-for-your-organization), make sure that an organization owner or billing manager has set the spending limit for {% data variables.product.prodname_codespaces %}. For more information, see "[Managing your spending limit for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)."
2022

2123
### Codespace does not open when created

0 commit comments

Comments
 (0)