Skip to content

Commit

Permalink
Merge pull request #35943 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Jan 15, 2025
2 parents 5a72146 + 87776f2 commit 80e83b2
Show file tree
Hide file tree
Showing 51 changed files with 49 additions and 168 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Anytime you comment in a conversation or when someone @mentions your username, y

For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox. For more information, see [Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings).

![Screenshot of the "Notification settings" page. The "Participating" and "Watching" settings are shown, each with two checkbox options, titled "Email" and "Web and Mobile".](/assets/images/help/notifications-v2/participating-and-watching-options.png){% endif %}
![Screenshot of the "Notification settings" page. "Participating" and "Watching" each have two checkbox options: "Email" and "Web and Mobile".](/assets/images/help/notifications-v2/participating-and-watching-options.png){% endif %}

For example, on your "Notification settings" page:
* If you don't want notifications to be sent to your email, deselect **email** for participating and watching notifications.
Expand Down Expand Up @@ -236,16 +236,14 @@ For more information about the notification delivery methods available to you, a

For more information on how to configure notifications for {% data variables.secret-scanning.alerts %}, see [AUTOTITLE](/code-security/secret-scanning/managing-alerts-from-secret-scanning/monitoring-alerts).

{% ifversion update-notification-settings-22 or ghes %}

## {% data variables.product.prodname_actions %} notification options

For repositories that are set up with {% data variables.product.prodname_actions %} and that you are watching, you can choose how you want to receive workflow run updates.

{% ifversion update-notification-settings-22 %}
1. On the "Notification settings" page, under "System", then under "Actions", select the **Don't notify** dropdown menu.

![Screenshot of the "System" section of the notification settings. Under "Actions," a dropdown menu, titled "Don't notify", is highlighted with an orange outline.](/assets/images/help/notifications/github-actions-customize-notifications.png)
![Screenshot of the "System" section of the notification settings. Under "Actions," a dropdown menu, titled "Don't notify", is outlined in orange.](/assets/images/help/notifications/github-actions-customize-notifications.png)
1. To opt into web notifications, from the dropdown menu, select "On {% data variables.product.prodname_dotcom %}."

To opt into email notifications, from the dropdown menu, select "Email."
Expand All @@ -254,9 +252,7 @@ For repositories that are set up with {% data variables.product.prodname_actions
{% ifversion ghes %}
On the "Notification settings" page, select "Email" or "Web" notifications. Optionally, to only receive notifications for failed workflow runs, select "Send notifications for failed workflows only".

![Screenshot of the "Actions" section on the "Notification settings" page. Three checkboxes, titled "Email", "Web", and "Send notifications for failed workflows only", are shown.](/assets/images/help/notifications-v2/github-actions-notification-options.png){% endif %}

{% endif %}
![Screenshot of the "Actions" section of "Notification settings" with checkboxes: "Email", "Web", and "Send notifications for failed workflows only."](/assets/images/help/notifications-v2/github-actions-notification-options.png){% endif %}

## Organization alerts notification options

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,6 @@ Add pronouns to your public user profile to share information about yourself wit

{% endif %}

{% ifversion profile-time-zone %}

## Setting your location and time zone

You can set a location and time zone on your profile to show other people your local time. Your location and time zone will be visible:
Expand All @@ -111,8 +109,6 @@ When you view your profile, you will see your location, local time, and your tim
* Select the **Time zone** dropdown menu, then click your local time zone.
{% data reusables.profile.update-profile %}

{% endif %}

{% ifversion profile-social-links %}

## Adding links to your social accounts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The person you invite to be your successor must have a {% data variables.product

1. Under "Successor settings", to invite a successor, begin typing a username, full name, or email address, then click their name when it appears.

![Screenshot of the "Successor settings" section. The string "octocat" is entered in a search field, and Octocat's profile is listed in a dropdown below.](/assets/images/help/settings/settings-invite-successor-search-field.png)
![Screenshot of the "Successor settings" section. The string "octocat" is entered in a search field, and Octocat's profile is listed in a dropdown.](/assets/images/help/settings/settings-invite-successor-search-field.png)

1. Click **Add successor**.
{% data reusables.user-settings.sudo-mode-popup %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,6 @@ By default, all keyboard shortcuts are enabled on {% data variables.product.prod
* To customize the keyboard shortcuts for triggering the command palette, under "Command palette", use the drop-down menus to choose a keyboard shortcut. For more information, see [AUTOTITLE](/get-started/accessibility/github-command-palette).
{%- endif %}

{% ifversion motion-management %}

## Managing motion

You can control how {% data variables.product.product_name %} displays animated _.gif_ images.
Expand All @@ -61,5 +59,3 @@ By default, {% data variables.product.product_name %} syncs with your system-lev
1. Under "Motion", manage settings for motion.

* To control how {% data variables.product.product_name %} displays animated images, under "Autoplay animated images", select **Sync with system**, **Enabled**, or **Disabled**.

{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ For an overview of repository-level security, see [AUTOTITLE](/code-security/get
1. Under {% ifversion code-security-wording-only %}"Code security"{% else %}"Code security and analysis"{% endif %}, to the right of the feature, click **Disable all** or **Enable all**.
1. Optionally, enable the feature by default for new repositories that you own.{% ifversion not ghes %}

![Screenshot of the "Enable FEATURE" modal dialog, with the "Enable by default for new private repositories" option highlighted with a dark orange outline.](/assets/images/help/settings/security-and-analysis-enable-by-default-in-modal.png){% endif %}
![Screenshot of the "Enable FEATURE" modal dialog, with the "Enable by default for new private repositories" option outlined in dark orange.](/assets/images/help/settings/security-and-analysis-enable-by-default-in-modal.png){% endif %}

1. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories you own.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ You can customize how non-essential cookies behave on any {% data variables.prod

1. Under "Manage cookie preferences," to accept or reject each non-essential cookie, click **Accept** or **Reject**.

![Screenshot of the "Manage cookie preferences" dialog window. Under "Analytics," two radio buttons, labeled "Accept" and "Reject," are outlined in orange.](/assets/images/help/settings/cookie-settings-accept-or-reject.png)
![Screenshot of the "Manage cookie preferences" dialog. Under "Analytics", two radio buttons, labeled "Accept" and "Reject," are outlined.](/assets/images/help/settings/cookie-settings-accept-or-reject.png)

1. Click **Save changes**.
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You can set scheduled reminders for personal or team-level review requests for p
{% data reusables.reminders.scheduled-reminders %}
1. Next to the organization you'd like to schedule reminders for, click {% octicon "pencil" aria-label="Edit reminder" %}.

![Screenshot of the settings for a personal account showing the name of a GitHub organization. An edit button with a pencil icon is outlined in dark orange.](/assets/images/help/settings/scheduled-reminders-org-choice.png)
![Screenshot of the settings for a personal account showing the name of a GitHub organization. An edit button with a pencil icon is outlined in orange.](/assets/images/help/settings/scheduled-reminders-org-choice.png)

{% data reusables.reminders.authorize-slack %}
{% data reusables.reminders.days-dropdown %}
Expand All @@ -45,7 +45,7 @@ You can set scheduled reminders for personal or team-level review requests for p
{% data reusables.reminders.scheduled-reminders %}
1. Next to the organization you'd like to edit scheduled reminders for, click {% octicon "pencil" aria-label="Edit reminder" %}.

![Screenshot of the settings for a personal account showing the name of a GitHub organization. An edit button with a pencil icon is outlined in dark orange.](/assets/images/help/settings/scheduled-reminders-org-choice.png)
![Screenshot of the settings for a personal account showing the name of a GitHub organization. An edit button with a pencil icon is outlined in orange.](/assets/images/help/settings/scheduled-reminders-org-choice.png)

{% data reusables.reminders.edit-page %}
{% data reusables.reminders.update-buttons %}
Expand All @@ -57,7 +57,7 @@ You can set scheduled reminders for personal or team-level review requests for p
{% data reusables.reminders.scheduled-reminders %}
1. Next to the organization you'd like to delete reminders for, click {% octicon "pencil" aria-label="Edit reminder" %}.

![Screenshot of the settings for a personal account showing the name of a GitHub organization. An edit button with a pencil icon is outlined in dark orange.](/assets/images/help/settings/scheduled-reminders-org-choice.png)
![Screenshot of the settings for a personal account showing the name of a GitHub organization. An edit button with a pencil icon is outlined in orange.](/assets/images/help/settings/scheduled-reminders-org-choice.png)

{% data reusables.reminders.delete %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ shortTitle: Show or hide membership
* To publicize your membership, choose **Public**.
* To hide your membership, choose **Private**.

![Screenshot of an entry in the list of organization members. To the right of the username, a dropdown menu, labeled "Private", is outlined in dark orange.](/assets/images/help/organizations/member-visibility-link.png)
![Screenshot of an entry in the list of organization members. Next to the username, a dropdown menu, labeled "Private", is outlined in dark orange.](/assets/images/help/organizations/member-visibility-link.png)
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ shortTitle: Request {% data variables.product.prodname_oauth_app %} approval

## About requesting organization approval for an {% data variables.product.prodname_oauth_app %}

Organization members can always request owner approval for {% data variables.product.prodname_oauth_apps %} they'd like to use, and organization owners receive a notification of pending requests.{% ifversion limit-app-access-requests %} Outside collaborators can request owner approval for {% data variables.product.prodname_oauth_apps %} they'd like to use if integration access requests are enabled. For more information, see [AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests).{% endif %}
Organization members can always request owner approval for {% data variables.product.prodname_oauth_apps %} they'd like to use, and organization owners receive a notification of pending requests. Outside collaborators can request owner approval for {% data variables.product.prodname_oauth_apps %} they'd like to use if integration access requests are enabled. For more information, see [AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/limiting-oauth-app-and-github-app-access-requests).

## Requesting organization approval for an {% data variables.product.prodname_oauth_app %} you've already authorized for your personal account

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ shortTitle: User into an organization
> * Since organizations cannot star repositories, you will no longer have access to your original list of starred repositories.
> * You will no longer have access to the list of users you were following from your user account.
> * Any followers of your user account will not automatically follow the new organization.
{% ifversion projects-v2 %}> * Any existing collaborators on your projects will still have access to those projects in the new organization.{% endif %}
> * Any existing collaborators on your projects will still have access to those projects in the new organization.
> * {% data variables.product.prodname_actions %} is not automatically enabled on the account after converting it to an organization, and will have to be re-enabled. To re-enable {% data variables.product.prodname_actions %}, create a new workflow file in the `.github/workflows` directory of your repository.
## Prerequisites
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,8 @@ For information on supported operating systems for self-hosted runners, or using
You can set up automation to scale the number of self-hosted runners. For more information, see [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners/autoscaling-with-self-hosted-runners).

{% ifversion actions-single-use-tokens %}

You can register ephemeral runners that perform a single job before the registration is cleaned up by using just-in-time runner registration. For more information, see [AUTOTITLE](/actions/security-guides/security-hardening-for-github-actions#using-just-in-time-runners).

{% endif %}

## Prerequisites

{% data reusables.actions.self-hosted-runners-prerequisites %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,8 @@ The {% data variables.product.prodname_actions %} service will then automaticall
> [!NOTE]
> If a job is labeled for a certain type of runner, but none matching that type are available, the job does not immediately fail at the time of queueing. Instead, the job will remain queued until the 24 hour timeout period expires.
{% ifversion actions-single-use-tokens %}

Alternatively, you can create ephemeral, just-in-time runners using the REST API. For more information, see [AUTOTITLE](/rest/actions/self-hosted-runners).

{% endif %}

## Controlling runner software updates on self-hosted runners

By default, self-hosted runners will automatically perform a software update whenever a new version of the runner software is available. If you use ephemeral runners in containers then this can lead to repeated software updates when a new runner version is released. Turning off automatic updates allows you to update the runner version on the container image directly on your own schedule.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,7 @@ shortTitle: Remove self-hosted runners
> [!NOTE]
> * {% data reusables.actions.self-hosted-runner-removal-impact %}
> * {% data reusables.actions.self-hosted-runner-auto-removal %}
{%- ifversion actions-single-use-tokens %}
> * {% data reusables.actions.jit-runner-removal %}
{%- endif %}
To remove a self-hosted runner from a user repository you must be the repository owner. Organization owners{% ifversion custom-org-roles %} and users with the "Manage organization runners and runner groups" permission{% endif %} can remove a runner from a repository in the organization. {% ifversion custom-org-roles %}For more information about custom organization roles, see [AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-organization-roles).{% endif %}

Expand All @@ -42,9 +40,7 @@ For information about how to remove a self-hosted runner with the REST API, see
> [!NOTE]
> * {% data reusables.actions.self-hosted-runner-removal-impact %}
> * {% data reusables.actions.self-hosted-runner-auto-removal %}
{%- ifversion actions-single-use-tokens %}
> * {% data reusables.actions.jit-runner-removal %}
{%- endif %}
To remove a self-hosted runner from an organization, you must be an organization owner{% ifversion custom-org-roles %} or have the "Manage organization runners and runner groups" permission{% endif %}. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see [AUTOTITLE](/rest/actions/self-hosted-runners).

Expand All @@ -67,11 +63,8 @@ If you use {% data variables.product.prodname_ghe_cloud %}, you can also remove
> [!NOTE]
> * {% data reusables.actions.self-hosted-runner-removal-impact %}
> * {% data reusables.actions.self-hosted-runner-auto-removal %}
{%- ifversion actions-single-use-tokens %}
> * {% data reusables.actions.jit-runner-removal %}
{%- endif %}

To remove a self-hosted runner from an enterprise, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. For information about how to remove a self-hosted runner with the REST API, see the enterprise endpoints in the [{% data variables.product.prodname_actions %} REST API](/rest/actions/self-hosted-runners).

{% data reusables.actions.self-hosted-runner-reusing %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The following table shows the permissions granted to the `GITHUB_TOKEN` by defau
| {% endif %} |
| issues | read/write | none | read |
| metadata | read | read | read |
| packages | read/write | {% ifversion actions-default-workflow-permissions-restrictive %}read{% else %}none{% endif %} | read |
| packages | read/write | read | read |
| pages | read/write | none | read |
| pull-requests | read/write | none | read |
| repository-projects | read/write | none | read |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -352,8 +352,6 @@ You should also consider the environment of the self-hosted runner machines:

Some customers might attempt to partially mitigate these risks by implementing systems that automatically destroy the self-hosted runner after each job execution. However, this approach might not be as effective as intended, as there is no way to guarantee that a self-hosted runner only runs one job. Some jobs will use secrets as command-line arguments which can be seen by another job running on the same runner, such as `ps x -w`. This can lead to secret leakages.

{% ifversion actions-single-use-tokens %}

### Using just-in-time runners

To improve runner registration security, you can use the REST API to create ephemeral, just-in-time (JIT) runners. These self-hosted runners perform at most one job before being automatically removed from the repository, organization, or enterprise. For more information about configuring JIT runners, see [AUTOTITLE](/rest/actions/self-hosted-runners#create-configuration-for-a-just-in-time-runner-for-an-organization).
Expand All @@ -367,8 +365,6 @@ Once you have the config file from the REST API response, you can pass it to the
./run.sh --jitconfig ${encoded_jit_config}
```

{% endif %}

### Planning your management strategy for self-hosted runners

A self-hosted runner can be added to various levels in your {% data variables.product.prodname_dotcom %} hierarchy: the enterprise, organization, or repository level. This placement determines who will be able to manage the runner:
Expand Down
Loading

0 comments on commit 80e83b2

Please sign in to comment.