Skip to content

Commit

Permalink
Merge pull request github#28436 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Sep 22, 2023
2 parents cfad18f + 72c5f0c commit cfd4aec
Show file tree
Hide file tree
Showing 53 changed files with 217 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ The repository owner has full control of the repository. In addition to the acti
| Create security advisories | "[AUTOTITLE](/code-security/security-advisories/working-with-repository-security-advisories/about-repository-security-advisories)" |
| Display a sponsor button | "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}
| Allow or disallow auto-merge for pull requests | "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository)" |
| Manage webhooks and deploy keys | "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys)" |
| Manage deploy keys | "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys)" |
| Manage webhooks | "[AUTOTITLE](/webhooks/about-webhooks)" |

## Collaborator access for a repository owned by a personal account

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ For a definition of common terms, see "[AUTOTITLE](/actions/learn-github-actions
Browse the complete list of CI starter workflow offered by {% data variables.product.company_short %} in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.location.product_location %}{% endif %}.

{% ifversion fpt or ghec %}

## Further reading

- "[AUTOTITLE](/billing/managing-billing-for-github-actions)"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ topics:
| Running tests on the runner | `npm test`|

## Example workflow

The following workflow was created by the {% data variables.product.prodname_dotcom %} Docs Engineering team. The workflow runs tests against the code in a pull request. To review the latest version of this file in the [`github/docs`](https://github.com/github/docs) repository, see [`test.yml`](https://github.com/github/docs/blob/main/.github/workflows/test.yml).

```yaml annotate copy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ type: tutorial
{% endif %}

{% ifversion ghec or ghes or ghae %}

## Changing which organizations can access a runner group

{%- ifversion fpt or ghec or ghes %}
Expand Down Expand Up @@ -110,12 +111,14 @@ You can edit the name of your runner groups at the enterprise and organization l
- [Changing the name of an enterprise runner group](#changing-the-name-of-an-enterprise-runner-group)

### Changing the name of an organization runner group

{% endif %}

{% data reusables.actions.runner-groups-org-navigation %}
{% data reusables.actions.changing-the-name-of-a-runner-group %}

{% ifversion ghes or ghec or ghae %}

### Changing the name of an enterprise runner group

{% data reusables.actions.runner-groups-enterprise-navigation %}
Expand All @@ -135,6 +138,7 @@ You can edit the name of your runner groups at the enterprise and organization l
- [Moving an enterprise runner to a group](#moving-an-enterprise-runner-to-a-group)

### Moving an organization runner to a group

{% endif %}

{% data reusables.organizations.navigate-to-org %}
Expand All @@ -143,6 +147,7 @@ You can edit the name of your runner groups at the enterprise and organization l
{% data reusables.actions.moving-a-runner-to-a-group %}

{% ifversion ghes or ghec or ghae %}

### Moving an enterprise runner to a group

{% data reusables.enterprise-accounts.access-enterprise %}
Expand All @@ -161,12 +166,14 @@ You can edit the name of your runner groups at the enterprise and organization l
- [Removing a runner group from an enterprise](#removing-a-runner-group-from-an-enterprise)

### Removing a runner group from an organization

{% endif %}

{% data reusables.actions.runner-groups-org-navigation %}
{% data reusables.actions.removing-a-runner-group %}

{% ifversion ghes or ghec or ghae %}

### Removing a runner group from an enterprise

{% data reusables.actions.runner-groups-enterprise-navigation %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ You can create custom labels for runners at the repository{% ifversion ghec or g
{% data reusables.actions.self-hosted-runners-create-label-steps %}

{% ifversion ghec or ghes or ghae %}

### Creating a custom label for an enterprise runner

{% data reusables.enterprise-accounts.access-enterprise %}
Expand All @@ -46,6 +47,7 @@ You can create custom labels for runners at the repository{% ifversion ghec or g
{% data reusables.actions.self-hosted-runners-create-label-steps %}

{% endif %}

## Assigning a label to a self-hosted runner

You can assign labels to self-hosted runners at the repository{% ifversion ghec or ghes or ghae %}, organization, and enterprise{% else %} and organization{% endif %} levels.
Expand All @@ -65,6 +67,7 @@ You can assign labels to self-hosted runners at the repository{% ifversion ghec
{% data reusables.actions.self-hosted-runner-assign-label-steps %}

{% ifversion ghec or ghes or ghae %}

### Assigning a label to an enterprise runner

{% data reusables.enterprise-accounts.access-enterprise %}
Expand All @@ -75,6 +78,7 @@ You can assign labels to self-hosted runners at the repository{% ifversion ghec
{% data reusables.actions.self-hosted-runner-assign-label-steps %}

{% endif %}

## Removing a custom label from a self-hosted runner

You can remove custom labels from self-hosted runners at the repository{% ifversion ghec or ghes or ghae %}, organization, and enterprise{% else %} and organization{% endif %} levels.
Expand All @@ -94,6 +98,7 @@ You can remove custom labels from self-hosted runners at the repository{% ifvers
{% data reusables.actions.self-hosted-runner-remove-label-steps %}

{% ifversion ghec or ghes or ghae %}

### Removing a custom label from an enterprise runner

{% data reusables.enterprise-accounts.access-enterprise %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ For example, the following diagram has a runner group named `grp-ubuntu-20.04-16
{% data reusables.actions.section-using-unique-names-for-runner-groups %}

{% ifversion ghec %}

## Changing which organizations can access a runner group

{% data reusables.actions.hosted-runner-security-admonition %}
Expand Down Expand Up @@ -112,12 +113,14 @@ You can rename runner groups at the enterprise and organization levels.
- [Changing the name of an enterprise runner group](##changing-the-name-of-an-enterprise-runner-group)

### Changing the name of an organization runner group

{% endif %}

{% data reusables.actions.runner-groups-org-navigation %}
{% data reusables.actions.changing-the-name-of-a-runner-group %}

{% ifversion ghec %}

### Changing the name of an enterprise runner group

{% data reusables.actions.runner-groups-enterprise-navigation %}
Expand All @@ -133,6 +136,7 @@ You can rename runner groups at the enterprise and organization levels.
- [Moving an enterprise runner to a group](#moving-an-enterprise-runner-to-a-group)

### Moving an organization runner to a group

{% endif %}

{% data reusables.organizations.navigate-to-org %}
Expand All @@ -141,6 +145,7 @@ You can rename runner groups at the enterprise and organization levels.
{% data reusables.actions.moving-a-runner-to-a-group %}

{% ifversion ghec %}

### Moving an enterprise runner to a group

{% data reusables.enterprise-accounts.access-enterprise %}
Expand All @@ -159,12 +164,14 @@ You can rename runner groups at the enterprise and organization levels.
- [Removing a runner group from an enterprise](#removing-a-runner-group-from-an-enterprise)

### Removing a runner group from an organization

{% endif %}

{% data reusables.actions.runner-groups-org-navigation %}
{% data reusables.actions.removing-a-runner-group %}

{% ifversion ghec %}

### Removing a runner group from an enterprise

{% data reusables.actions.runner-groups-enterprise-navigation %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ redirect_from:
---

{% ifversion ghec %}

## Adding a {% data variables.actions.hosted_runner %} to an enterprise

Enterprise owners can add {% data variables.actions.hosted_runner %}s to an enterprise and assign them to organizations. By default, when a {% data variables.actions.hosted_runner %} is created for an enterprise, it is added to a default runner group that all organizations in the enterprise have access to. While all organizations are granted access to the runner, the repositories in each organization **are not** granted access. For each organization, an organization owner must configure the runner group to specify which repositories have access to the enterprise runner. For more information, see "[Allowing repositories to access a runner group](#allowing-repositories-to-access-a-runner-group)."
Expand Down Expand Up @@ -69,6 +70,7 @@ You can edit the name of your {% data variables.actions.hosted_runner %}s.
- [Changing the name of an enterprise runner](#changing-the-name-of-an-enterprise-runner)

### Changing the name of an organization runner

{% endif %}

{% data reusables.organizations.navigate-to-org %}
Expand All @@ -78,6 +80,7 @@ You can edit the name of your {% data variables.actions.hosted_runner %}s.
{% data reusables.actions.rename-larger-runner %}

{% ifversion ghec %}

### Changing the name of an enterprise runner

{% data reusables.enterprise-accounts.access-enterprise %}
Expand All @@ -95,7 +98,9 @@ You can control the maximum number of jobs allowed to run concurrently for speci
{% ifversion ghec %}
- [Configuring autoscaling for an organization runner](#configuring-autoscaling-for-an-organization-runner)
- [Configuring autoscaling for an enterprise runner](#configuring-autoscaling-for-an-enterprise-runner)

### Configuring autoscaling for an organization runner

{% endif %}

{% data reusables.organizations.navigate-to-org %}
Expand All @@ -105,6 +110,7 @@ You can control the maximum number of jobs allowed to run concurrently for speci
{% data reusables.actions.configure-autoscaling-for-larger-runners %}

{% ifversion ghec %}

### Configuring autoscaling for an enterprise runner

{% data reusables.enterprise-accounts.access-enterprise %}
Expand Down Expand Up @@ -133,6 +139,7 @@ The number of available IP addresses in the assigned ranges does not restrict nu
- [Creating static IP addresses for enterprise runners](#creating-static-ip-addresses-for-enterprise-runners)

### Creating static IP addresses for organization runners

{% endif %}

{% data reusables.organizations.navigate-to-org %}
Expand All @@ -142,6 +149,7 @@ The number of available IP addresses in the assigned ranges does not restrict nu
{% data reusables.actions..networking-for-larger-runners %}

{% ifversion ghec %}

### Creating static IP addresses for enterprise runners

{% data reusables.enterprise-accounts.access-enterprise %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,7 @@ On an instance in a high-availability configuration, after you restore to new di
To remediate after the restoration completes and before starting replication, you can tear down stale UUIDs using `ghe-repl-teardown`. If you need further assistance, contact {% data variables.contact.contact_ent_support %}.
{% ifversion backup-utilities-progress %}
## Monitoring backup or restoration progress
During a backup or restoration operation, you can use the `ghe-backup-progress` utility on your backup host to monitor the operation's progress. The utility prints the progress of each job sequentially.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ Optionally, organization owners can further restrict the access policy of the ru
For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/managing-access-to-self-hosted-runners-using-groups#changing-the-access-policy-of-a-self-hosted-runner-group)."

## 5. Automatically scale your self-hosted runners

{% ifversion actions-runner-controller %}Optionally, you can use {% data variables.product.prodname_actions_runner_controller %} (ARC) to automatically scale self-hosted runners. {% data reusables.actions.actions-runner-controller-about-arc %}

{% else %}Optionally, you can build custom tooling to automatically scale the self-hosted runners for {% ifversion ghec or ghae %}your enterprise{% elsif ghes %}{% data variables.location.product_location %}{% endif %}. For example, your tooling can respond to webhook events from {% data variables.location.product_location %} to automatically scale a cluster of runner machines. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/autoscaling-with-self-hosted-runners)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,6 @@ Some authenticators allow passkeys to be used with nearby devices. For example,
1. On your nearby device, follow the prompts to complete the authentication process. For example, if you are using an iPhone, you might perform FaceID or enter your passcode.

## Further reading

- [AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys)
- [AUTOTITLE](/authentication/authenticating-with-a-passkey/managing-your-passkeys)
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ To confirm access for sudo mode, you {% ifversion totp-and-mobile-sudo-challenge
{%- endif %}

{% ifversion passkeys %}

## Confirming access using a passkey

You must have a passkey registered to your account to confirm access to your account for sudo mode using a passkey. For more information, see "[AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys)" and "[AUTOTITLE](/authentication/authenticating-with-a-passkey/managing-your-passkeys)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ If you've set up a security key on your account, and your browser supports secur
1. Select the appropriate option in the prompt. Depending on your security key configuration, you may type a PIN, complete a biometric prompt, or use a physical security key.

{% ifversion passkeys %}

### Using a passkey

If you have enabled 2FA, and you have added a passkey to your account, you can use the passkey to sign in. Since passkeys satisfy both password and 2FA requirements, you can complete your sign in with a single step. For more information, see "[AUTOTITLE](/authentication/authenticating-with-a-passkey/about-passkeys)" and "[AUTOTITLE](/authentication/authenticating-with-a-passkey/signing-in-with-a-passkey)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ To reduce the number of paid seats your organization uses, you can remove member
1. Review the information about your new payment on your next billing date, then click **Remove seats**.

{% ifversion ghec %}

## Downgrading your enterprise account's plan

Enterprise accounts are only available with {% data variables.product.prodname_enterprise %}, so it's not possible to downgrade an enterprise account to another plan.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,7 @@ For information on bulk enablement, see "[AUTOTITLE](/code-security/code-scannin

{% endif %}
{% ifversion ghes < 3.5 %}

## Reasons for the "Analysis not found" message

If you used a pull request to add {% data variables.product.prodname_code_scanning %} to the repository, you will initially see an "Analysis not found" message when you click **Details** on the "{% data variables.product.prodname_code_scanning_caps %} results / TOOL NAME" check in a pull request.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ If the code in a repository changes to include {% ifversion code-scanning-defaul

{% endif %}
{% ifversion org-enable-code-scanning %}

## Configuring default setup for all eligible repositories in an organization

Through the "Code security and analysis" page of your organization's settings, you can enable default setup for all eligible repositories in your organization. For more information on repository eligibility, see "[Eligible repositories for {% data variables.product.prodname_codeql %} default setup at scale](#eligible-repositories-default-setup)."
Expand All @@ -80,6 +81,7 @@ Through the "Code security and analysis" page of your organization's settings, y
{% data variables.product.prodname_code_scanning_caps %} is configured at the repository level. For more information, see "[AUTOTITLE](/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning)."
{% endif %}
{% ifversion code-security-multi-repo-enablement %}

## Configuring default setup for a subset of repositories in an organization

Through security overview for your organization, you can find eligible repositories for default setup, then enable default setup across each of those repositories simultaneously. For more information on repository eligibility, see "[Eligible repositories for {% data variables.product.prodname_codeql %} default setup at scale](#eligible-repositories-default-setup)."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ If your codebase depends on a library or framework that is not recognized by the
If you need to change any other aspects of your {% data variables.product.prodname_code_scanning %} configuration, consider configuring advanced setup. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/configuring-advanced-setup-for-code-scanning)."

{% ifversion code-scanning-without-workflow-310 %}

## Customizing your existing configuration of default setup

{% data reusables.repositories.navigate-to-repo %}
Expand All @@ -38,6 +39,7 @@ If you need to change any other aspects of your {% data variables.product.prodna
1. To update your configuration, as well as run an initial analysis of your code with the new configuration, click **Save changes**. All future analyses will use your new configuration.

{% else %}

## Changing the selected query suite for your configuration of default setup

{% data reusables.repositories.navigate-to-repo %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,14 @@ versions:
On very large projects, you may see `Error: "Out of disk"` or `Error: "Out of memory"` on self-hosted runners when running {% data variables.product.prodname_codeql %}. In this case, you may need to increase the memory or disk space available on your runners. You can review the recommended hardware resources for running {% data variables.product.prodname_codeql %} to make sure your self-hosted runners meet those requirements. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/recommended-hardware-resources-for-running-codeql)."

{% else %}

## Use self-hosted runners

Self-hosted runners offer more control of hardware, operating system, and software tools than {% data variables.product.company_short %}-hosted runners can provide. For more information, see "[AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/about-self-hosted-runners)." You can review the recommended hardware resources for running {% data variables.product.prodname_codeql %} to make sure your self-hosted runners meet those requirements. For more information, see "[AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/recommended-hardware-resources-for-running-codeql)."

{% ifversion actions-hosted-runners %}

## Use larger runners

You can use larger runners, which are {% data variables.product.company_short %}-hosted runners with more RAM, CPU, and disk space than standard runners. These runners have the runner application and other tools preinstalled. For more information about larger runners and the specifications you can use with them, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-larger-runners)."{% endif %}
{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@ $ codeql database analyze /codeql-dbs/example-repo \
```

{% ifversion code-scanning-tool-status-page %}

### Adding file coverage information to your results for monitoring

You can optionally submit file coverage information to {% data variables.product.product_name %} for display on the {% data variables.code-scanning.tool_status_page %} for {% data variables.product.prodname_code_scanning %}. For more information about file coverage information, see "[AUTOTITLE](/code-security/code-scanning/managing-your-code-scanning-configuration/about-the-tool-status-page#how-codeql-defines-scanned-files)."
Expand Down
Loading

0 comments on commit cfd4aec

Please sign in to comment.