Merge branch 'main' into github-premium-support
This commit is contained in:
@@ -55,3 +55,19 @@ You can access repositories on {% data variables.product.product_name %} from th
|
||||
* You can work with all repositories on {% data variables.product.product_name %} over SSH, although firewalls and proxys might refuse to allow SSH connections. Using SSH requires you to generate an SSH public/private keypair on your local machine and add the public key to your {% data variables.product.product_name %} account. Every time you use Git to authenticate with {% data variables.product.product_name %}, you'll be prompted to enter your SSH key passphrase, unless you've [stored the key](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent#adding-your-ssh-key-to-the-ssh-agent). For more information, see "[Generating a new SSH key and adding it to the ssh-agent](/github/authenticating-to-github/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)."
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" %}To use a personal access token or SSH key to access resources owned by an organization that uses SAML single sign-on, you must also authorize the personal token or SSH key. For more information, see "[Authorizing a personal access token for use with SAML single sign-on](/github/authenticating-to-github/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" or "[Authorizing an SSH key for use with SAML single sign-on](/github/authenticating-to-github/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)."{% endif %}
|
||||
|
||||
{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
|
||||
|
||||
### {% data variables.product.company_short %}'s token formats
|
||||
|
||||
{% data variables.product.company_short %} issues tokens that begin with a prefix to indicate the token's type.
|
||||
|
||||
| Token type | Prefix | More information |
|
||||
| :- | :- | :- |
|
||||
| Personal access token | `ghp_` | "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)" |
|
||||
| OAuth access token | `gho_` | "[Authorizing {% data variables.product.prodname_oauth_apps %}](/developers/apps/authorizing-oauth-apps)" |
|
||||
| User-to-server token for a {% data variables.product.prodname_github_app %} | `ghu_` | "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/developers/apps/identifying-and-authorizing-users-for-github-apps)" |
|
||||
| Server-to-server token for a {% data variables.product.prodname_github_app %} | `ghs_` | "[Authenticating with {% data variables.product.prodname_github_apps %}](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation)" |
|
||||
| Refresh token for a {% data variables.product.prodname_github_app %} | `ghr_` | "[Refreshing user-to-server access tokens](/developers/apps/refreshing-user-to-server-access-tokens)" |
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -39,9 +39,14 @@ Personal access tokens (PATs) are an alternative to using passwords for authenti
|
||||
{% endif %}
|
||||
7. Click **Generate token**.
|
||||

|
||||
8. Click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the token to your clipboard. For security reasons, after you navigate off the page, you will not be able to see the token again.{% if currentVersion == "free-pro-team@latest" %}
|
||||
{% else %}
|
||||
{% endif %}
|
||||
8. Click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the token to your clipboard. For security reasons, after you navigate off the page, you will not be able to see the token again.
|
||||
{% if currentVersion == "free-pro-team@latest" %}
|
||||

|
||||
{% elsif currentVersion ver_gt "enterprise-server@3.1" or currentVersion == "github-ae@next" %}
|
||||

|
||||
{% else %}
|
||||

|
||||
{% endif %}
|
||||
|
||||
{% warning %}
|
||||
|
||||
|
||||
@@ -38,7 +38,7 @@ You need write permission to view a summary of all the alerts for a repository o
|
||||
{% data reusables.repositories.sidebar-security %}
|
||||
{% data reusables.repositories.sidebar-code-scanning-alerts %}
|
||||
1. Under "{% data variables.product.prodname_code_scanning_capc %}," click the alert you'd like to explore.
|
||||

|
||||

|
||||
1. Optionally, if the alert highlights a problem with data flow, click **Show paths** to display the path from the data source to the sink where it's used.
|
||||

|
||||
1. Alerts from {% data variables.product.prodname_codeql %} analysis include a description of the problem. Click **Show more** for guidance on how to fix your code.
|
||||
@@ -52,7 +52,7 @@ If you have write permission for a repository, you can view fixed alerts by view
|
||||
|
||||
Alerts may be fixed in one branch but not in another. You can use the "Branch" drop-down menu, on the summary of alerts, to check whether an alert is fixed in a particular branch.
|
||||
|
||||

|
||||

|
||||
|
||||
{% if currentVersion == "enterprise-server@2.22" %}
|
||||
|
||||
@@ -105,11 +105,11 @@ To dismiss or delete alerts:
|
||||
|
||||
Optionally, you can use the filters to display a subset of alerts and then delete all matching alerts at once. For example, if you have removed a query from {% data variables.product.prodname_codeql %} analysis, you can use the "Rule" filter to list just the alerts for that query and then select and delete all of those alerts.
|
||||
|
||||

|
||||

|
||||
|
||||
1. If you want to dismiss an alert, it's important to explore the alert first, so that you can choose the correct dismissal reason. Click the alert you'd like to explore.
|
||||
|
||||

|
||||

|
||||
|
||||
1. Review the alert, then click **Dismiss** and choose a reason for closing the alert.
|
||||

|
||||
|
||||
@@ -69,7 +69,7 @@ After setting up {% data variables.product.prodname_code_scanning %} for your re
|
||||
|
||||
**Note:** If you raised a pull request to add the {% data variables.product.prodname_code_scanning %} workflow to the repository, alerts from that pull request aren't displayed directly on the {% data variables.product.prodname_code_scanning_capc %} page until the pull request is merged. If any alerts were found you can view these, before the pull request is merged, by clicking the **_n_ alerts found** link in the banner on the {% data variables.product.prodname_code_scanning_capc %} page.
|
||||
|
||||

|
||||

|
||||
|
||||
{% endnote %}
|
||||
|
||||
@@ -95,7 +95,7 @@ There are other situations where there may be no analysis for the latest commit
|
||||
|
||||
To check whether a branch has been scanned, go to the {% data variables.product.prodname_code_scanning_capc %} page, click the **Branch** drop-down and select the relevant branch.
|
||||
|
||||

|
||||

|
||||
|
||||
The solution in this situation is to add the name of the base branch to the `on:push` and `on:pull_request` specification in the {% data variables.product.prodname_code_scanning %} workflow on that branch and then make a change that updates the open pull request that you want to scan.
|
||||
|
||||
|
||||
@@ -245,18 +245,17 @@ You can also schedule when {% data variables.product.prodname_mobile %} will sen
|
||||
|
||||
1. In the bottom menu, tap **Profile**.
|
||||
2. To view your settings, tap {% octicon "gear" aria-label="The Gear icon" %}.
|
||||
3. To update your notification settings, tap **Notifications** and then use the toggles to enable or disable your preferred types of push notifications.
|
||||
4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Receive Notifications**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications.
|
||||
3. To update your notification settings, tap **Configure Notifications** and then use the toggles to enable or disable your preferred types of push notifications.
|
||||
4. Optionally, to schedule when {% data variables.product.prodname_mobile %} will send push notifications to your mobile device, tap **Working Hours**, use the **Custom working hours** toggle, and then choose when you would like to receive push notifications.
|
||||
|
||||
### Configuring your watch settings for an individual repository with {% data variables.product.prodname_mobile %}
|
||||
|
||||
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% if currentVersion == "free-pro-team@latest" %}certain event types such as issues, pull requests, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository.
|
||||
|
||||
1. On {% data variables.product.prodname_mobile %}, navigate to main page of the repository.
|
||||
1. On {% data variables.product.prodname_mobile %}, navigate to the main page of the repository.
|
||||
2. Tap **Watch**.
|
||||

|
||||
3. To choose what activities you receive notifications for, tap your preferred watch settings.
|
||||

|
||||
{% data reusables.notifications-v2.custom-notifications-beta %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
@@ -99,8 +99,6 @@ You can enable or disable features for all repositories. {% if currentVersion ==
|
||||
|
||||
### Allowing {% data variables.product.prodname_dependabot %} to access private dependencies
|
||||
|
||||
{% data reusables.dependabot.beta-note %}
|
||||
|
||||
{% data variables.product.prodname_dependabot %} can check for outdated dependency references in a project and automatically generate a pull request to update them. To do this, {% data variables.product.prodname_dependabot %} must have access to all of the targeted dependency files. Typically, version updates will fail if one or more dependencies are inaccessible. For more information, see "[About {% data variables.product.prodname_dependabot %} version updates](/github/administering-a-repository/about-dependabot-version-updates)."
|
||||
|
||||
By default, {% data variables.product.prodname_dependabot %} can't update dependencies that are located in private repositories or private package registries. However, if a dependency is in a private {% data variables.product.prodname_dotcom %} repository within the same organization as the project that uses that dependency, you can allow {% data variables.product.prodname_dependabot %} to update the version successfully by giving it access to the host repository.
|
||||
|
||||
@@ -49,7 +49,7 @@ An apex domain is a custom domain that does not contain a subdomain, such as `ex
|
||||
|
||||
An apex domain is configured with an `A`, `ALIAS`, or `ANAME` record through your DNS provider. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/articles/managing-a-custom-domain-for-your-github-pages-site#configuring-an-apex-domain)."
|
||||
|
||||
{% data reusables.pages.www-and-apex-domain-recommendation %}
|
||||
{% data reusables.pages.www-and-apex-domain-recommendation %} For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site/#configuring-a-subdomain)."
|
||||
|
||||
### Updating custom domains when your {% data variables.product.prodname_pages %} site is disabled
|
||||
|
||||
|
||||
@@ -60,9 +60,9 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl
|
||||
|
||||
### Configuring an apex domain
|
||||
|
||||
To set up an apex domain, such as `example.com`, you must configure a _CNAME_ file in your {% data variables.product.prodname_pages %} repository and an `ALIAS`, `ANAME`, or `A` record with your DNS provider.
|
||||
To set up an apex domain, such as `example.com`, you must configure a _CNAME_ file in your {% data variables.product.prodname_pages %} repository and at least one `ALIAS`, `ANAME`, or `A` record with your DNS provider.
|
||||
|
||||
{% data reusables.pages.www-and-apex-domain-recommendation %}
|
||||
{% data reusables.pages.www-and-apex-domain-recommendation %} For more information, see "[Configuring a subdomain](#configuring-a-subdomain)."
|
||||
|
||||
{% data reusables.pages.navigate-site-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
@@ -70,7 +70,7 @@ To set up an apex domain, such as `example.com`, you must configure a _CNAME_ fi
|
||||

|
||||
5. Navigate to your DNS provider and create either an `ALIAS`, `ANAME`, or `A` record. {% data reusables.pages.contact-dns-provider %}
|
||||
- To create an `ALIAS` or `ANAME` record, point your apex domain to the default domain for your site. {% data reusables.pages.default-domain-information %}
|
||||
- To create an `A` record, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}.
|
||||
- To create `A` records, point your apex domain to the IP addresses for {% data variables.product.prodname_pages %}.
|
||||
```shell
|
||||
185.199.108.153
|
||||
185.199.109.153
|
||||
|
||||
@@ -30,6 +30,7 @@ Before you can use Jekyll to test a site, you must:
|
||||
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
{% data reusables.pages.navigate-publishing-source %}
|
||||
3. Run `bundle install`.
|
||||
3. Run your Jekyll site locally.
|
||||
```shell
|
||||
$ bundle exec jekyll serve
|
||||
|
||||
@@ -23,8 +23,8 @@ Then, make sure the _CNAME_ file is formatted correctly.
|
||||
|
||||
- The _CNAME_ filename must be all uppercase.
|
||||
- The _CNAME_ file can contain only one domain. To point multiple domains to your site, you must set up a redirect through your DNS provider.
|
||||
- The _CNAME_ entry must be the bare domain. For example, `www.example.com`,`blog.example.com`, or `example.com`.
|
||||
- The _CNAME_ entry can only be used once on {% data variables.product.product_name %}. For example, if another repository's _CNAME_ file contains `example.com`, you cannot use `example.com` in the _CNAME_ file for your repository.
|
||||
- The _CNAME_ file must contain the domain name only. For example, `www.example.com`, `blog.example.com`, or `example.com`.
|
||||
- The domain name must be unique across all {% data variables.product.prodname_pages %} sites. For example, if another repository's _CNAME_ file contains `example.com`, you cannot use `example.com` in the _CNAME_ file for your repository.
|
||||
|
||||
### DNS misconfiguration
|
||||
|
||||
@@ -41,6 +41,8 @@ Make sure your site does not:
|
||||
- Use more than one `www` subdomain. For example, both `www.example.com` and `www.anotherexample.com`.
|
||||
- Use both an apex domain and custom subdomain. For example, both `example.com` and `docs.example.com`.
|
||||
|
||||
The one exception is the `www` subdomain. If configured correctly, the `www` subdomain is automatically redirected to the apex domain. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site#configuring-an-apex-domain)."
|
||||
|
||||
{% data reusables.pages.wildcard-dns-warning %}
|
||||
|
||||
For a list of supported custom domains, see "[About custom domains and {% data variables.product.prodname_pages %}](/articles/about-custom-domains-and-github-pages/#supported-custom-domains)."
|
||||
|
||||
Reference in New Issue
Block a user