GHEC version (#20947)
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: Grace Park <gracepark@github.com> Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com> Co-authored-by: Robert Sese <sese@github.com> Co-authored-by: Peter Bengtsson <peterbe@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com>
Двоичные данные
assets/images/enterprise/business-accounts/repository-invitation-policy-drop-down.png
Normal file
После Ширина: | Высота: | Размер: 64 KiB |
Двоичные данные
assets/images/enterprise/business-accounts/repository-permissions-policy-drop-down.png
Normal file
После Ширина: | Высота: | Размер: 248 KiB |
До Ширина: | Высота: | Размер: 51 KiB После Ширина: | Высота: | Размер: 13 KiB |
До Ширина: | Высота: | Размер: 32 KiB После Ширина: | Высота: | Размер: 58 KiB |
До Ширина: | Высота: | Размер: 40 KiB После Ширина: | Высота: | Размер: 56 KiB |
Двоичные данные
assets/images/enterprise/site-admin-settings/add-global-webhook-select-individual-events-ghes-and-ae.png
Normal file
После Ширина: | Высота: | Размер: 186 KiB |
До Ширина: | Высота: | Размер: 14 KiB После Ширина: | Высота: | Размер: 213 KiB |
До Ширина: | Высота: | Размер: 64 KiB После Ширина: | Высота: | Размер: 306 KiB |
|
@ -24,12 +24,14 @@ featuredLinks:
|
|||
changelog:
|
||||
label: profiles, github-themes, notifications
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
layout: product-landing
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Profiles
|
||||
|
|
|
@ -10,6 +10,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
children:
|
||||
|
|
|
@ -7,6 +7,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
children:
|
||||
|
|
|
@ -5,6 +5,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
redirect_from:
|
||||
|
@ -16,7 +17,7 @@ To help you understand your subscriptions and decide whether to unsubscribe, see
|
|||
|
||||
{% note %}
|
||||
|
||||
**Note:** Instead of unsubscribing, you have the option to ignore a repository. If you ignore a repository, you won't receive any notifications. We don't recommend ignoring repositories as you won't be notified if you're @mentioned. {% ifversion fpt %}If you're experiencing abuse and want to ignore a repository, please contact {% data variables.contact.contact_support %} so we can help. {% data reusables.policies.abuse %}{% endif %}
|
||||
**Note:** Instead of unsubscribing, you have the option to ignore a repository. If you ignore a repository, you won't receive any notifications. We don't recommend ignoring repositories as you won't be notified if you're @mentioned. {% ifversion fpt or ghec %}If you're experiencing abuse and want to ignore a repository, please contact {% data variables.contact.contact_support %} so we can help. {% data reusables.policies.abuse %}{% endif %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
@ -64,7 +65,7 @@ When you unwatch a repository, you unsubscribe from future updates from that rep
|
|||
1. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down to click **Watched repositories**.
|
||||
![Manage notifications drop down menu options](/assets/images/help/notifications-v2/manage-notifications-options.png)
|
||||
2. On the watched repositories page, after you've evaluated the repositories you're watching, choose whether to:
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
|
||||
- Unwatch a repository
|
||||
- Ignore all notifications for a repository
|
||||
- Customize the types of event you receive notifications for ({% data reusables.notifications-v2.custom-notification-types %}, if enabled)
|
||||
|
@ -72,4 +73,4 @@ When you unwatch a repository, you unsubscribe from future updates from that rep
|
|||
- Unwatch a repository
|
||||
- Only watch releases for a repository
|
||||
- Ignore all notifications for a repository
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
|
|
@ -20,6 +20,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
shortTitle: View subscriptions
|
||||
|
@ -37,7 +38,7 @@ When your inbox has too many notifications to manage, consider whether you have
|
|||
For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#automatic-watching)."
|
||||
|
||||
To see an overview of your repository subscriptions, see "[Reviewing repositories that you're watching](#reviewing-repositories-that-youre-watching)."
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
|
||||
{% tip %}
|
||||
|
||||
**Tip:** You can select the types of event to be notified of by using the **Custom** option of the **Watch/Unwatch** dropdown list in your [watching page](https://github.com/watching) or on any repository page on {% data variables.product.product_name %}. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)."
|
||||
|
@ -71,7 +72,7 @@ Many people forget about repositories that they've chosen to watch in the past.
|
|||
1. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down menu and click **Watched repositories**.
|
||||
![Manage notifications drop down menu options](/assets/images/help/notifications-v2/manage-notifications-options.png)
|
||||
2. Evaluate the repositories that you are watching and decide if their updates are still relevant and helpful. When you watch a repository, you will be notified of all conversations for that repository.
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
|
||||
![Watched notifications page](/assets/images/help/notifications-v2/watched-notifications-custom.png)
|
||||
{% else %}
|
||||
![Watched notifications page](/assets/images/help/notifications-v2/watched-notifications.png)
|
||||
|
@ -79,7 +80,7 @@ Many people forget about repositories that they've chosen to watch in the past.
|
|||
|
||||
{% tip %}
|
||||
|
||||
**Tip:** Instead of watching a repository, consider only receiving notifications {% ifversion fpt or ghes > 3.0 or ghae-next %}when there are updates to {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository), or any combination of these options,{% else %}for releases in a repository,{% endif %} or completely unwatching a repository.
|
||||
**Tip:** Instead of watching a repository, consider only receiving notifications {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}when there are updates to {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository), or any combination of these options,{% else %}for releases in a repository,{% endif %} or completely unwatching a repository.
|
||||
|
||||
When you unwatch a repository, you can still be notified when you're @mentioned or participating in a thread. When you configure to receive notifications for certain event types, you're only notified when there are updates to these event types in the repository, you're participating in a thread, or you or a team you're on is @mentioned.
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: About notifications
|
||||
intro: 'Notifications provide updates about the activity on {% data variables.product.product_name %} that you''ve subscribed to. You can use the notifications inbox to customize, triage, and manage your updates.'
|
||||
intro: 'Notifications provide updates about the activity on {% data variables.product.product_location %} that you''ve subscribed to. You can use the notifications inbox to customize, triage, and manage your updates.'
|
||||
redirect_from:
|
||||
- /articles/notifications/
|
||||
- /articles/about-notifications
|
||||
|
@ -11,6 +11,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
---
|
||||
|
@ -20,14 +21,14 @@ topics:
|
|||
|
||||
## Notifications and subscriptions
|
||||
|
||||
You can choose to receive ongoing updates about specific activity on {% data variables.product.product_name %} through a subscription. Notifications are updates that you receive for specific activity that you are subscribed to.
|
||||
You can choose to receive ongoing updates about specific activity on {% data variables.product.product_location %} through a subscription. Notifications are updates that you receive for specific activity that you are subscribed to.
|
||||
|
||||
### Subscription options
|
||||
|
||||
You can choose to subscribe to notifications for:
|
||||
- A conversation in a specific issue, pull request, or gist.
|
||||
- All activity in a repository or team discussion.
|
||||
- CI activity, such as the status of workflows in repositories set up with {% data variables.product.prodname_actions %}. {% ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
- CI activity, such as the status of workflows in repositories set up with {% data variables.product.prodname_actions %}. {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
|
||||
- Repository {% data reusables.notifications-v2.custom-notification-types %} (if enabled).{% else %}
|
||||
- Releases in a repository.{% endif %}
|
||||
|
||||
|
@ -49,19 +50,19 @@ In general, you are automatically subscribed to conversations by default when yo
|
|||
|
||||
By default, you also automatically watch all repositories that you create and are owned by your user account.
|
||||
|
||||
To unsubscribe from conversations you're automatically subscribed to, you can change your notification settings or directly unsubscribe or unwatch activity on {% data variables.product.product_name %}. For more information, see "[Managing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)."
|
||||
To unsubscribe from conversations you're automatically subscribed to, you can change your notification settings or directly unsubscribe or unwatch activity on {% data variables.product.product_location %}. For more information, see "[Managing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)."
|
||||
|
||||
## Customizing notifications and subscriptions
|
||||
|
||||
You can choose to view your notifications through the notifications inbox at [https://github.com/notifications](https://github.com/notifications){% ifversion fpt or ghes > 2.22 %} and in the {% data variables.product.prodname_mobile %} app{% endif %}, through your email, or some combination of these options.
|
||||
You can choose to view your notifications through the notifications inbox at [https://github.com/notifications](https://github.com/notifications){% ifversion fpt or ghes > 2.22 or ghec %} and in the {% data variables.product.prodname_mobile %} app{% endif %}, through your email, or some combination of these options.
|
||||
|
||||
To customize the types of updates you'd like to receive and where to send those updates, configure your notification settings. For more information, see “[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications).”
|
||||
To customize the types of updates you'd like to receive and where to send those updates, configure your notification settings. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)."
|
||||
|
||||
To keep your subscriptions manageable, review your subscriptions and watched repositories and unsubscribe as needed. For more information, see "[Managing subscriptions for activity on GitHub](/github/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github)."
|
||||
|
||||
To customize how you'd like to receive updates for specific pull requests or issues, you can configure your preferences within the issue or pull request. For more information, see “[Triaging a single notification](/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification#customizing-when-to-receive-future-updates-for-an-issue-or-pull-request).”
|
||||
To customize how you'd like to receive updates for specific pull requests or issues, you can configure your preferences within the issue or pull request. For more information, see "[Triaging a single notification](/github/managing-subscriptions-and-notifications-on-github/triaging-a-single-notification#customizing-when-to-receive-future-updates-for-an-issue-or-pull-request)."
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 %}
|
||||
{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
You can customize and schedule push notifications in the {% data variables.product.prodname_mobile %} app. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#managing-your-notification-settings-with-github-for-mobile)."
|
||||
{% endif %}
|
||||
|
||||
|
@ -91,7 +92,7 @@ From your inbox you can also triage multiple notifications at once. For more inf
|
|||
|
||||
## Customizing your notifications inbox
|
||||
|
||||
To focus on a group of notifications in your inbox on {% data variables.product.product_name %}{% ifversion fpt or ghes > 2.22 %} or {% data variables.product.prodname_mobile %}{% endif %}, you can create custom filters. For example, you can create a custom filter for an open source project you contribute to and only see notifications for that repository in which you are mentioned. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox)." For more examples of how to customize your triaging workflow, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)."
|
||||
To focus on a group of notifications in your inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} or {% data variables.product.prodname_mobile %}{% endif %}, you can create custom filters. For example, you can create a custom filter for an open source project you contribute to and only see notifications for that repository in which you are mentioned. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox)." For more examples of how to customize your triaging workflow, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)."
|
||||
|
||||
## Notification retention policy
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Configuring notifications
|
||||
intro: 'Choose the type of activity on {% data variables.product.product_name %} that you want to receive notifications for and how you want these updates delivered.'
|
||||
intro: 'Choose the type of activity on {% data variables.product.prodname_dotcom %} that you want to receive notifications for and how you want these updates delivered.'
|
||||
redirect_from:
|
||||
- /articles/about-web-notifications
|
||||
- /format-of-notification-emails/
|
||||
|
@ -19,6 +19,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
---
|
||||
|
@ -28,13 +29,13 @@ topics:
|
|||
|
||||
## Notification delivery options
|
||||
|
||||
You can receive notifications for activity on {% data variables.product.product_name %} in the following locations.
|
||||
You can receive notifications for activity on {% data variables.product.product_location %} in the following locations.
|
||||
|
||||
- The notifications inbox in the {% data variables.product.product_name %} web interface{% ifversion fpt or ghes > 2.22 %}
|
||||
- The notifications inbox on {% data variables.product.prodname_mobile %}, which syncs with the inbox on {% data variables.product.product_name %}{% endif %}
|
||||
- An email client that uses a verified email address, which can also sync with the notifications inbox on {% data variables.product.product_name %}{% ifversion fpt or ghes > 2.22 %} and {% data variables.product.prodname_mobile %}{% endif %}
|
||||
- The notifications inbox in the {% data variables.product.product_location %} web interface{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
- The notifications inbox on {% data variables.product.prodname_mobile %}, which syncs with the inbox on {% data variables.product.product_location %}{% endif %}
|
||||
- An email client that uses a verified email address, which can also sync with the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 %}
|
||||
{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Choosing your notification settings](#choosing-your-notification-settings)."
|
||||
{% endif %}
|
||||
|
||||
|
@ -42,17 +43,17 @@ You can receive notifications for activity on {% data variables.product.product_
|
|||
|
||||
### Benefits of the notifications inbox
|
||||
|
||||
The notifications inbox on {% data variables.product.product_name %}{% ifversion fpt or ghes > 2.22 %} and {% data variables.product.prodname_mobile %}{% endif %} includes triaging options designed specifically for your {% data variables.product.product_name %} notifications flow, including options to:
|
||||
The notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} and {% data variables.product.prodname_mobile %}{% endif %} includes triaging options designed specifically for your {% data variables.product.prodname_dotcom %} notifications flow, including options to:
|
||||
- Triage multiple notifications at once.
|
||||
- Mark completed notifications as **Done** and remove them from your inbox. To view all of your notifications marked as **Done**, use the `is:done` query.
|
||||
- Save a notification to review later. Saved notifications are flagged in your inbox and kept indefinitely. To view all of your saved notifications, use the `is:saved` query.
|
||||
- Unsubscribe and remove a notification from your inbox.
|
||||
- Preview the issue, pull request, or team discussion where the notification originates on {% data variables.product.product_name %} from within the notifications inbox.
|
||||
- Preview the issue, pull request, or team discussion where the notification originates on {% data variables.product.product_location %} from within the notifications inbox.
|
||||
- See one of the latest reasons you're receiving a notification from your inbox with a `reasons` label.
|
||||
- Create custom filters to focus on different notifications when you want.
|
||||
- Group notifications in your inbox by repository or date to get a quick overview with less context switching
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 %}
|
||||
{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
In addition, you can receive and triage notifications on your mobile device with {% data variables.product.prodname_mobile %}. For more information, see "[Managing your notification settings with GitHub for mobile](#managing-your-notification-settings-with-github-for-mobile)" or "[GitHub for mobile](/github/getting-started-with-github/github-for-mobile)."
|
||||
{% endif %}
|
||||
|
||||
|
@ -75,7 +76,7 @@ To see repositories that you're watching, go to your [watching page](https://git
|
|||
{% endif %}
|
||||
You can configure notifications for a repository on the repository page, or on your watching page.{% ifversion ghes < 3.1 %} You can choose to only receive notifications for releases in a repository, or ignore all notifications for a repository.{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
|
||||
|
||||
### About custom notifications
|
||||
You can customize notifications for a repository. For example, you can choose to only be notified when updates to one or more types of events ({% data reusables.notifications-v2.custom-notification-types %}) happen within a repository, or ignore all notifications for a repository.
|
||||
|
@ -84,7 +85,7 @@ You can customize notifications for a repository. For example, you can choose to
|
|||
### Participating in conversations
|
||||
Anytime you comment in a conversation or when someone @mentions your username, you are _participating_ in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox.
|
||||
|
||||
For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_name %}{% ifversion fpt or ghes > 2.22 %} and {% data variables.product.prodname_mobile %}{% endif %}.
|
||||
For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes > 2.22 or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}.
|
||||
|
||||
![Participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png)
|
||||
|
||||
|
@ -92,17 +93,17 @@ For example:
|
|||
- If you don't want notifications to be sent to your email, unselect **email** for participating and watching notifications.
|
||||
- If you want to receive notifications by email when you've participated in a conversation, then you can select **email** under "Participating".
|
||||
|
||||
If you do not enable watching or participating notifications for web{% ifversion fpt or ghes > 2.22 %} and mobile{% endif %}, then your notifications inbox will not have any updates.
|
||||
If you do not enable watching or participating notifications for web{% ifversion fpt or ghes > 2.22 or ghec %} and mobile{% endif %}, then your notifications inbox will not have any updates.
|
||||
|
||||
## Customizing your email notifications
|
||||
|
||||
After enabling email notifications, {% data variables.product.product_name %} will send notifications to you as multipart emails that contain both HTML and plain text copies of the content. Email notification content includes any Markdown, @mentions, emojis, hash-links, and more, that appear in the original content on {% data variables.product.product_name %}. If you only want to see the text in the email, you can configure your email client to display the plain text copy only.
|
||||
After enabling email notifications, {% data variables.product.product_location %} will send notifications to you as multipart emails that contain both HTML and plain text copies of the content. Email notification content includes any Markdown, @mentions, emojis, hash-links, and more, that appear in the original content on {% data variables.product.product_location %}. If you only want to see the text in the email, you can configure your email client to display the plain text copy only.
|
||||
|
||||
{% data reusables.notifications.outbound_email_tip %}
|
||||
|
||||
{% data reusables.notifications.shared_state %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
If you're using Gmail, you can click a button beside the notification email to visit the original issue or pull request that generated the notification.
|
||||
|
||||
|
@ -110,7 +111,7 @@ If you're using Gmail, you can click a button beside the notification email to v
|
|||
|
||||
{% endif %}
|
||||
|
||||
Choose a default email address where you want to send updates for conversations you're participating in or watching. You can also specify which activity on {% data variables.product.product_name %} you want to receive updates for using your default email address. For example, choose whether you want updates to your default email from:
|
||||
Choose a default email address where you want to send updates for conversations you're participating in or watching. You can also specify which activity on {% data variables.product.product_location %} you want to receive updates for using your default email address. For example, choose whether you want updates to your default email from:
|
||||
- Comments on issues and pull requests.
|
||||
- Pull request reviews.
|
||||
- Pull request pushes.
|
||||
|
@ -124,18 +125,18 @@ You can also send notifications for a specific repository to an email address. F
|
|||
|
||||
## Filtering email notifications
|
||||
|
||||
Each email notification that {% data variables.product.product_name %} sends contains header information. The header information in every email is consistent, so you can use it in your email client to filter or forward all {% data variables.product.product_name %} notifications, or certain types of {% data variables.product.product_name %} notifications.
|
||||
Each email notification that {% data variables.product.product_location %} sends contains header information. The header information in every email is consistent, so you can use it in your email client to filter or forward all {% data variables.product.prodname_dotcom %} notifications, or certain types of {% data variables.product.prodname_dotcom %} notifications.
|
||||
|
||||
If you believe you're receiving notifications that don't belong to you, examine the `X-GitHub-Recipient` and `X-GitHub-Recipient-Address` headers. These headers show who the intended recipient is. Depending on your email setup, you may receive notifications intended for another user.
|
||||
|
||||
Email notifications from {% data variables.product.product_name %} contain the following header information:
|
||||
Email notifications from {% data variables.product.product_location %} contain the following header information:
|
||||
|
||||
| Header | Information |
|
||||
| --- | --- |
|
||||
| `From` address | This address will always be {% ifversion fpt %}'`notifications@github.com`'{% else %}'the no-reply email address configured by your site administrator'{% endif %}. |
|
||||
| `From` address | This address will always be {% ifversion fpt or ghec %}'`notifications@github.com`'{% else %}'the no-reply email address configured by your site administrator'{% endif %}. |
|
||||
| `To` field | This field connects directly to the thread.{% ifversion not ghae %} If you reply to the email, you'll add a new comment to the conversation.{% endif %} |
|
||||
| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are: <ul><li>`assign`: You were assigned to an issue or pull request.</li><li>`author`: You created an issue or pull request.</li><li>`ci_activity`: A {% data variables.product.prodname_actions %} workflow run that you triggered was completed.</li><li>`comment`: You commented on an issue or pull request.</li><li>`manual`: There was an update to an issue or pull request you manually subscribed to.</li><li>`mention`: You were mentioned on an issue or pull request.</li><li>`push`: Someone committed to a pull request you're subscribed to.</li><li>`review_requested`: You or a team you're a member of was requested to review a pull request.</li>{% ifversion fpt or ghes or ghae-issue-4864 %}<li>`security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.</li>{% endif %}<li>`state_change`: An issue or pull request you're subscribed to was either closed or opened.</li><li>`subscribed`: There was an update in a repository you're watching.</li><li>`team_mention`: A team you belong to was mentioned on an issue or pull request.</li><li>`your_activity`: You opened, commented on, or closed an issue or pull request.</li></ul> |
|
||||
| `mailing list` field | This field identifies the name of the repository and its owner. The format of this address is always `<repository name>.<repository owner>.{% data variables.command_line.backticks %}`. |{% ifversion fpt or ghes or ghae-issue-4864 %}
|
||||
| `Cc` address | {% data variables.product.product_name %} will `Cc` you if you're subscribed to a conversation. The second `Cc` email address matches the notification reason. The suffix for these notification reasons is {% data variables.notifications.cc_address %}. The possible notification reasons are: <ul><li>`assign`: You were assigned to an issue or pull request.</li><li>`author`: You created an issue or pull request.</li><li>`ci_activity`: A {% data variables.product.prodname_actions %} workflow run that you triggered was completed.</li><li>`comment`: You commented on an issue or pull request.</li><li>`manual`: There was an update to an issue or pull request you manually subscribed to.</li><li>`mention`: You were mentioned on an issue or pull request.</li><li>`push`: Someone committed to a pull request you're subscribed to.</li><li>`review_requested`: You or a team you're a member of was requested to review a pull request.</li>{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}<li>`security_alert`: {% data variables.product.prodname_dotcom %} detected a vulnerability in a repository you receive alerts for.</li>{% endif %}<li>`state_change`: An issue or pull request you're subscribed to was either closed or opened.</li><li>`subscribed`: There was an update in a repository you're watching.</li><li>`team_mention`: A team you belong to was mentioned on an issue or pull request.</li><li>`your_activity`: You opened, commented on, or closed an issue or pull request.</li></ul> |
|
||||
| `mailing list` field | This field identifies the name of the repository and its owner. The format of this address is always `<repository name>.<repository owner>.{% data variables.command_line.backticks %}`. |{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
|
||||
| `X-GitHub-Severity` field | {% data reusables.repositories.security-alerts-x-github-severity %} The possible severity levels are:<ul><li>`low`</li><li>`moderate`</li><li>`high`</li><li>`critical`</li></ul>For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." |{% endif %}
|
||||
|
||||
## Choosing your notification settings
|
||||
|
@ -144,8 +145,8 @@ Email notifications from {% data variables.product.product_name %} contain the f
|
|||
{% data reusables.notifications-v2.manage-notifications %}
|
||||
3. On the notifications settings page, choose how you receive notifications when:
|
||||
- There are updates in repositories or team discussions you're watching or in a conversation you're participating in. For more information, see "[About participating and watching notifications](#about-participating-and-watching-notifications)."
|
||||
- You gain access to a new repository or you've joined a new team. For more information, see "[Automatic watching](#automatic-watching)."{% ifversion fpt or ghes or ghae-issue-4864 %}
|
||||
- There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options)." {% endif %} {% ifversion fpt %}
|
||||
- You gain access to a new repository or you've joined a new team. For more information, see "[Automatic watching](#automatic-watching)."{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
|
||||
- There are new {% data variables.product.prodname_dependabot_alerts %} in your repository. For more information, see "[{% data variables.product.prodname_dependabot_alerts %} notification options](#dependabot-alerts-notification-options)." {% endif %} {% ifversion fpt or ghec %}
|
||||
- There are workflow runs updates on repositories set up with {% data variables.product.prodname_actions %}. For more information, see "[{% data variables.product.prodname_actions %} notification options](#github-actions-notification-options)."{% endif %}
|
||||
|
||||
## Automatic watching
|
||||
|
@ -158,17 +159,17 @@ If "Automatically watch repositories" is disabled, then you will not automatical
|
|||
|
||||
## Configuring your watch settings for an individual repository
|
||||
|
||||
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% ifversion fpt or ghes > 3.0 or ghae-next %}certain event types such as {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository) {% else %}new releases{% endif %}, or completely ignore an individual repository.
|
||||
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}certain event types such as {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository) {% else %}new releases{% endif %}, or completely ignore an individual repository.
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
2. In the upper-right corner, select the "Watch" drop-down menu to click a watch option.
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-issue-4910 %}
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-issue-4910 or ghec %}
|
||||
![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom.png)
|
||||
|
||||
The **Custom** option allows you to further customize notifications so that you're only notified when specific events happen in the repository, in addition to participating and @mentions.
|
||||
{% else %}
|
||||
![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options.png){% endif %}
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-issue-4910 %}
|
||||
{% ifversion fpt or ghes > 3.0 or ghae-issue-4910 or ghec %}
|
||||
![Custom watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom2-dotcom.png)
|
||||
If you select "Issues", you will be notified about, and subscribed to, updates on every issue (including those that existed prior to you selecting this option) in the repository. If you're @mentioned in a pull request in this repository, you'll receive notifications for that too, and you'll be subscribed to updates on that specific pull request, in addition to being notified about issues.
|
||||
{% endif %}
|
||||
|
@ -187,7 +188,7 @@ If you belong to an organization, you can choose the email account you want noti
|
|||
|
||||
### Customizing email routes per organization
|
||||
|
||||
If you are a member of more than one organization, you can configure each one to send notifications to any of{% ifversion fpt %} your verified email addresses{% else %} the email addressed you've added to your {% data variables.product.product_name %} account{% endif %}. {% ifversion fpt %} For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."{% endif %}
|
||||
If you are a member of more than one organization, you can configure each one to send notifications to any of{% ifversion fpt or ghec %} your verified email addresses{% else %} the email addresses for your account{% endif %}. {% ifversion fpt or ghec %} For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."{% endif %}
|
||||
|
||||
{% data reusables.notifications.access_notifications %}
|
||||
{% data reusables.notifications-v2.manage-notifications %}
|
||||
|
@ -198,17 +199,17 @@ If you are a member of more than one organization, you can configure each one to
|
|||
5. Select one of your verified email addresses, then click **Save**.
|
||||
![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif)
|
||||
|
||||
{% ifversion fpt or ghes or ghae-issue-4864 %}
|
||||
{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
|
||||
## {% data variables.product.prodname_dependabot_alerts %} notification options
|
||||
|
||||
{% data reusables.notifications.vulnerable-dependency-notification-enable %}
|
||||
{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %}
|
||||
{% data reusables.notifications.vulnerable-dependency-notification-options %}
|
||||
|
||||
For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% ifversion fpt or ghes %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."
|
||||
For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes %}
|
||||
{% ifversion fpt or ghes or ghec %}
|
||||
## {% data variables.product.prodname_actions %} notification options
|
||||
|
||||
Choose how you want to receive workflow run updates for repositories that you are watching that are set up with {% data variables.product.prodname_actions %}. You can also choose to only receive notifications for failed workflow runs.
|
||||
|
@ -217,7 +218,7 @@ Choose how you want to receive workflow run updates for repositories that you ar
|
|||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 %}
|
||||
{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
## Managing your notification settings with {% data variables.product.prodname_mobile %}
|
||||
|
||||
When you install {% data variables.product.prodname_mobile %}, you will automatically be opted into web notifications. Within the app, you can enable push notifications for the following events.
|
||||
|
@ -246,7 +247,7 @@ You can also schedule when {% data variables.product.prodname_mobile %} will sen
|
|||
|
||||
## 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 {% ifversion fpt %}certain event types such as issues, pull requests, discussions (if enabled for the repository) and {% endif %}new releases, or completely ignore an individual repository.
|
||||
You can choose whether to watch or unwatch an individual repository. You can also choose to only be notified of {% ifversion fpt or ghec %}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 the main page of the repository.
|
||||
2. Tap **Watch**.
|
||||
|
|
|
@ -8,6 +8,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
children:
|
||||
|
|
|
@ -5,6 +5,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
redirect_from:
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
children:
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Managing notifications from your inbox
|
||||
intro: 'Use your inbox to quickly triage and sync your notifications across email{% ifversion fpt or ghes > 2.22 %} and mobile{% endif %}.'
|
||||
intro: 'Use your inbox to quickly triage and sync your notifications across email{% ifversion fpt or ghes > 2.22 or ghec %} and mobile{% endif %}.'
|
||||
redirect_from:
|
||||
- /articles/marking-notifications-as-read
|
||||
- /articles/saving-notifications-for-later
|
||||
|
@ -10,6 +10,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
shortTitle: Manage from your inbox
|
||||
|
@ -20,7 +21,7 @@ shortTitle: Manage from your inbox
|
|||
|
||||
## About your inbox
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 %}
|
||||
{% ifversion fpt or ghes > 2.22 or ghec %}
|
||||
{% data reusables.notifications-v2.notifications-inbox-required-setting %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)."
|
||||
{% endif %}
|
||||
|
||||
|
@ -97,7 +98,7 @@ Custom filters do not currently support:
|
|||
These are the types of filters that you can use:
|
||||
- Filter by repository with `repo:`
|
||||
- Filter by discussion type with `is:`
|
||||
- Filter by notification reason with `reason:`{% ifversion fpt %}
|
||||
- Filter by notification reason with `reason:`{% ifversion fpt or ghec %}
|
||||
- Filter by notification author with `author:`
|
||||
- Filter by organization with `org:`{% endif %}
|
||||
|
||||
|
@ -107,20 +108,20 @@ To add a `repo:` filter, you must include the owner of the repository in the que
|
|||
|
||||
### Supported `is:` queries
|
||||
|
||||
To filter notifications for specific activity on {% data variables.product.product_name %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% ifversion fpt or ghes %}{% data variables.product.prodname_dependabot %}{% else %} security{% endif %} alerts, use `is:repository-vulnerability-alert`.{% endif %}
|
||||
To filter notifications for specific activity on {% data variables.product.product_location %}, you can use the `is` query. For example, to only see repository invitation updates, use `is:repository-invitation`{% ifversion not ghae %}, and to only see {% ifversion fpt or ghes or ghec %}{% data variables.product.prodname_dependabot %}{% else %} security{% endif %} alerts, use `is:repository-vulnerability-alert`.{% endif %}
|
||||
|
||||
- `is:check-suite`
|
||||
- `is:commit`
|
||||
- `is:gist`
|
||||
- `is:issue-or-pull-request`
|
||||
- `is:release`
|
||||
- `is:repository-invitation`{% ifversion fpt or ghes or ghae-issue-4864 %}
|
||||
- `is:repository-vulnerability-alert`{% endif %}{% ifversion fpt %}
|
||||
- `is:repository-invitation`{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
|
||||
- `is:repository-vulnerability-alert`{% endif %}{% ifversion fpt or ghec %}
|
||||
- `is:repository-advisory`{% endif %}
|
||||
- `is:team-discussion`{% ifversion fpt %}
|
||||
- `is:team-discussion`{% ifversion fpt or ghec %}
|
||||
- `is:discussion`{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes or ghae-issue-4864 %}
|
||||
{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
|
||||
For information about reducing noise from notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for vulnerable dependencies](/github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies)."
|
||||
{% endif %}
|
||||
|
||||
|
@ -144,13 +145,13 @@ To filter notifications by why you've received an update, you can use the `reaso
|
|||
| `reason:invitation` | When you're invited to a team, organization, or repository.
|
||||
| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to.
|
||||
| `reason:mention` | You were directly @mentioned.
|
||||
| `reason:review-requested` | You or a team you're on have been requested to review a pull request.{% ifversion fpt or ghes or ghae-issue-4864 %}
|
||||
| `reason:review-requested` | You or a team you're on have been requested to review a pull request.{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
|
||||
| `reason:security-alert` | When a security alert is issued for a repository.{% endif %}
|
||||
| `reason:state-change` | When the state of a pull request or issue is changed. For example, an issue is closed or a pull request is merged.
|
||||
| `reason:team-mention` | When a team you're a member of is @mentioned.
|
||||
| `reason:ci-activity` | When a repository has a CI update, such as a new workflow run status.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
### Supported `author:` queries
|
||||
|
||||
To filter notifications by user, you can use the `author:` query. An author is the original author of the thread (issue, pull request, gist, discussions, and so on) for which you are being notified. For example, to see notifications for threads created by the Octocat user, use `author:octocat`.
|
||||
|
@ -163,10 +164,10 @@ For example, to see notifications from the octo-org organization, use `org:octo-
|
|||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes or ghae-issue-4864 %}
|
||||
{% ifversion fpt or ghes or ghae-issue-4864 or ghec %}
|
||||
## {% data variables.product.prodname_dependabot %} custom filters
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
If you use {% data variables.product.prodname_dependabot %} to keep your dependencies up-to-date, you can use and save these custom filters:
|
||||
- `is:repository_vulnerability_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %}.
|
||||
- `reason:security_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %} and security update pull requests.
|
||||
|
|
|
@ -5,6 +5,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Notifications
|
||||
redirect_from:
|
||||
|
|
|
@ -10,15 +10,16 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
shortTitle: Organization's profile
|
||||
---
|
||||
You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories.{% ifversion not ghes and not ghae %} You can customize your organization's profile by adding a README.md file. For more information, see "[Customizing your organization's profile](/organizations/collaborating-with-groups-in-organizations/customizing-your-organizations-profile)."{% endif %}
|
||||
|
||||
{% ifversion fpt %}To confirm your organization's identity and display a "Verified" badge on your organization profile page, you must verify your organization's domains with {% data variables.product.product_name %}. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)."{% endif %}
|
||||
{% ifversion fpt or ghec %}To confirm your organization's identity and display a "Verified" badge on your organization profile page, you must verify your organization's domains with {% data variables.product.product_name %}. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)."{% endif %}
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 %}
|
||||
{% ifversion fpt or ghes > 3.2 or ghec %}
|
||||
![Sample organization profile page](/assets/images/help/organizations/org_profile_with_overview.png)
|
||||
{% else %}
|
||||
![Sample organization profile page](/assets/images/help/profile/org_profile.png)
|
||||
|
|
|
@ -11,12 +11,13 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
---
|
||||
You can add personal information about yourself in your bio, like previous places you've worked, projects you've contributed to, or interests you have that other people may like to know about. For more information, see "[Adding a bio to your profile](/articles/personalizing-your-profile/#adding-a-bio-to-your-profile)."
|
||||
|
||||
{% ifversion fpt or ghes %}
|
||||
{% ifversion fpt or ghes or ghec %}
|
||||
|
||||
{% data reusables.profile.profile-readme %}
|
||||
|
||||
|
@ -28,9 +29,9 @@ People who visit your profile see a timeline of your contribution activity, like
|
|||
|
||||
People who visit your profile can also see the following information.
|
||||
|
||||
- Repositories and gists you own or contribute to. {% ifversion fpt or ghes %}You can showcase your best work by pinning repositories and gists to your profile. For more information, see "[Pinning items to your profile](/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile)."{% endif %}
|
||||
- Repositories and gists you own or contribute to. {% ifversion fpt or ghes or ghec %}You can showcase your best work by pinning repositories and gists to your profile. For more information, see "[Pinning items to your profile](/github/setting-up-and-managing-your-github-profile/pinning-items-to-your-profile)."{% endif %}
|
||||
- Repositories you've starred. For more information, see "[Saving repositories with stars](/articles/saving-repositories-with-stars/)."
|
||||
- An overview of your activity in organizations, repositories, and teams you're most active in. For more information, see "[Showing an overview of your activity on your profile](/articles/showing-an-overview-of-your-activity-on-your-profile)."{% ifversion fpt %}
|
||||
- An overview of your activity in organizations, repositories, and teams you're most active in. For more information, see "[Showing an overview of your activity on your profile](/articles/showing-an-overview-of-your-activity-on-your-profile)."{% ifversion fpt or ghec %}
|
||||
- Badges that show if you use {% data variables.product.prodname_pro %} or participate in programs like the {% data variables.product.prodname_arctic_vault %}, {% data variables.product.prodname_sponsors %}, or the {% data variables.product.company_short %} Developer Program. For more information, see "[Personalizing your profile](/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#displaying-badges-on-your-profile)."{% endif %}
|
||||
|
||||
You can also set a status on your profile to provide information about your availability. For more information, see "[Setting a status](/articles/personalizing-your-profile/#setting-a-status)."
|
||||
|
|
|
@ -8,6 +8,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
children:
|
||||
|
|
|
@ -4,6 +4,7 @@ intro: 'You can add a README to your {% data variables.product.prodname_dotcom %
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
redirect_from:
|
||||
|
@ -13,7 +14,7 @@ shortTitle: Your profile README
|
|||
---
|
||||
## About your profile README
|
||||
|
||||
You can share information about yourself with the community on {% data variables.product.prodname_dotcom %} by creating a profile README. {% data variables.product.prodname_dotcom %} shows your profile README at the top of your profile page.
|
||||
You can share information about yourself with the community on {% data variables.product.product_location %} by creating a profile README. {% data variables.product.prodname_dotcom %} shows your profile README at the top of your profile page.
|
||||
|
||||
You decide what information to include in your profile README, so you have full control over how you present yourself on {% data variables.product.prodname_dotcom %}. Here are some examples of information that visitors may find interesting, fun, or useful in your profile README.
|
||||
|
||||
|
|
|
@ -14,6 +14,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
shortTitle: Personalize
|
||||
|
@ -52,7 +53,7 @@ When you sign up for an account, {% data variables.product.product_name %} provi
|
|||
|
||||
You can change the name that is displayed on your profile. This name may also be displayed next to comments you make on private repositories owned by an organization. For more information, see "[Managing the display of member names in your organization](/articles/managing-the-display-of-member-names-in-your-organization)."
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
{% note %}
|
||||
|
||||
**Note:** If you're a member of an {% data variables.product.prodname_emu_enterprise %}, any changes to your profile name must be made through your identity provider instead of {% data variables.product.prodname_dotcom_the_website %}. {% data reusables.enterprise-accounts.emu-more-info-account %}
|
||||
|
@ -68,7 +69,7 @@ You can change the name that is displayed on your profile. This name may also be
|
|||
|
||||
Add a bio to your profile to share information about yourself with other {% data variables.product.product_name %} users. With the help of [@mentions](/articles/basic-writing-and-formatting-syntax) and emoji, you can include information about where you currently or have previously worked, what type of work you do, or even what kind of coffee you drink.
|
||||
|
||||
{% ifversion fpt or ghes %}
|
||||
{% ifversion fpt or ghes or ghec %}
|
||||
|
||||
For a longer-form and more prominent way of displaying customized information about yourself, you can also use a profile README. For more information, see "[Managing your profile README](/github/setting-up-and-managing-your-github-profile/managing-your-profile-readme)."
|
||||
|
||||
|
@ -110,7 +111,7 @@ When you set your status, you can also let people know that you have limited ava
|
|||
|
||||
If you select the "Busy" option, when people @mention your username, assign you an issue or pull request, or request a pull request review from you, a note next to your username will show that you're busy. You will also be excluded from automatic review assignment for pull requests assigned to any teams you belong to. For more information, see "[Managing code review assignment for your team](/organizations/organizing-members-into-teams/managing-code-review-assignment-for-your-team)."
|
||||
|
||||
1. In the top right corner of {% data variables.product.product_name %}, click your profile photo, then click **Set your status** or, if you already have a status set, click your current status.
|
||||
1. In the top right corner of {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% else %}{% data variables.product.product_name %}{% endif %}, click your profile photo, then click **Set your status** or, if you already have a status set, click your current status.
|
||||
![Button on profile to set your status](/assets/images/help/profile/set-status-on-profile.png)
|
||||
2. To add custom text to your status, click in the text field and type a status message.
|
||||
![Field to type a status message](/assets/images/help/profile/type-a-status-message.png)
|
||||
|
@ -125,7 +126,7 @@ If you select the "Busy" option, when people @mention your username, assign you
|
|||
7. Click **Set status**.
|
||||
![Button to set status](/assets/images/help/profile/set-status-button.png)
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
## Displaying badges on your profile
|
||||
|
||||
When you participate in certain programs, {% data variables.product.prodname_dotcom %} automatically displays a badge on your profile.
|
||||
|
@ -135,7 +136,7 @@ When you participate in certain programs, {% data variables.product.prodname_dot
|
|||
| ![Mars 2020 Helicopter Contributor badge icon](/assets/images/help/profile/badge-mars-2020-small.png) | **Mars 2020 Helicopter Contributor** | If you authored any commit(s) present in the commit history for the relevant tag of an open source library used in the Mars 2020 Helicopter Mission, you'll get a Mars 2020 Helicopter Contributor badge on your profile. Hovering over the badge shows you several of the repositories you contributed to that were used in the mission. For the full list of repositories that will qualify you for the badge, see "[List of qualifying repositories for Mars 2020 Helicopter Contributor badge](/github/setting-up-and-managing-your-github-profile/personalizing-your-profile#list-of-qualifying-repositories-for-mars-2020-helicopter-contributor-badge)." |
|
||||
| ![Arctic Code Vault Contributor badge icon](/assets/images/help/profile/badge-arctic-code-vault-small.png) | **{% data variables.product.prodname_arctic_vault %} Contributor** | If you authored any commit(s) on the default branch of a repository that was archived in the 2020 Arctic Vault program, you'll get an {% data variables.product.prodname_arctic_vault %} Contributor badge on your profile. Hovering over the badge shows you several of the repositories you contributed to that were part of the program. For more information on the program, see [{% data variables.product.prodname_archive %}](https://archiveprogram.github.com). |
|
||||
| ![{% data variables.product.prodname_dotcom %} Sponsor badge icon](/assets/images/help/profile/badge-sponsors-small.png) | **{% data variables.product.prodname_dotcom %} Sponsor** | If you sponsored an open source contributor through {% data variables.product.prodname_sponsors %} you'll get a {% data variables.product.prodname_dotcom %} Sponsor badge on your profile. Clicking the badge takes you to the **Sponsoring** tab of your profile. For more information, see "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)." |
|
||||
| {% octicon "cpu" aria-label="The Developer Program icon" %} | **Developer Program Member** | If you're a registered member of the {% data variables.product.prodname_dotcom %} Developer Program, building an app with the {% data variables.product.prodname_dotcom %} API, you'll get a Developer Program Member badge on your profile. For more information on the {% data variables.product.prodname_dotcom %} Developer Program, see [GitHub Developer](/program/). |
|
||||
| {% octicon "cpu" aria-label="The Developer Program icon" %} | **Developer Program Member** | If you're a registered member of the {% data variables.product.prodname_dotcom %} Developer Program, building an app with the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API, you'll get a Developer Program Member badge on your profile. For more information on the {% data variables.product.prodname_dotcom %} Developer Program, see [GitHub Developer](/program/). |
|
||||
| {% octicon "star-fill" aria-label="The star icon" %} | **Pro** | If you use {% data variables.product.prodname_pro %} you'll get a PRO badge on your profile. For more information about {% data variables.product.prodname_pro %}, see "[{% data variables.product.prodname_dotcom %}'s products](/github/getting-started-with-github/githubs-products#github-pro)." |
|
||||
| {% octicon "lock" aria-label="The lock icon" %} | **Security Bug Bounty Hunter** | If you helped out hunting down security vulnerabilities, you'll get a Security Bug Bounty Hunter badge on your profile. For more information about the {% data variables.product.prodname_dotcom %} Security program, see [{% data variables.product.prodname_dotcom %} Security](https://bounty.github.com/). |
|
||||
| {% octicon "mortar-board" aria-label="The mortar-board icon" %} | **Github Campus Expert** | If you participate in the {% data variables.product.prodname_dotcom %} Campus Program you'll get a {% data variables.product.prodname_dotcom %} Campus Expert badge on your profile. For more information about the Campus Experts program, see [Campus Experts](https://education.github.com/experts). |
|
||||
|
|
|
@ -9,6 +9,7 @@ redirect_from:
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
shortTitle: Pin items
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
children:
|
||||
|
|
|
@ -8,6 +8,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
children:
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Publicizing or hiding your private contributions on your profile
|
||||
intro: 'Your {% data variables.product.product_name %} profile shows a graph of your repository contributions over the past year. You can choose to show anonymized activity from {% ifversion fpt or ghes %}private and internal{% else %}private{% endif %} repositories{% ifversion fpt or ghes %} in addition to the activity from public repositories{% endif %}.'
|
||||
intro: 'Your {% data variables.product.product_name %} profile shows a graph of your repository contributions over the past year. You can choose to show anonymized activity from {% ifversion fpt or ghes or ghec %}private and internal{% else %}private{% endif %} repositories{% ifversion fpt or ghes or ghec %} in addition to the activity from public repositories{% endif %}.'
|
||||
redirect_from:
|
||||
- /articles/publicizing-or-hiding-your-private-contributions-on-your-profile
|
||||
- /github/setting-up-and-managing-your-github-profile/publicizing-or-hiding-your-private-contributions-on-your-profile
|
||||
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
shortTitle: Private contributions
|
||||
|
@ -18,7 +19,7 @@ If you publicize your private contributions, people without access to the privat
|
|||
|
||||
{% note %}
|
||||
|
||||
**Note:** {% ifversion fpt or ghes %}On {% ifversion fpt %}{% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}{% data variables.product.product_name %}{% endif %}, public contributions on your profile are visible {% ifversion fpt %}to anyone in the world who can access {% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}only to other users of {% data variables.product.product_location%}{% endif %}.{% elsif ghae %}On {% data variables.product.prodname_ghe_managed %}, only other members of your enterprise can see the contributions on your profile.{% endif %}
|
||||
**Note:** {% ifversion fpt or ghes or ghec %}On {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}{% data variables.product.product_name %}{% endif %}, public contributions on your profile are visible {% ifversion fpt or ghec %}to anyone in the world who can access {% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}only to other users of {% data variables.product.product_location%}{% endif %}.{% elsif ghae %}On {% data variables.product.prodname_ghe_managed %}, only other members of your enterprise can see the contributions on your profile.{% endif %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
|
|
|
@ -10,7 +10,8 @@ redirect_from:
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: 'next'
|
||||
ghae: next
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
shortTitle: Send enterprise contributions
|
||||
|
@ -18,7 +19,7 @@ shortTitle: Send enterprise contributions
|
|||
|
||||
## About enterprise contributions on your {% data variables.product.prodname_dotcom_the_website %} profile
|
||||
|
||||
Your {% data variables.product.prodname_dotcom_the_website %} profile shows {% ifversion fpt %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %}<!-- Remove condition entirely when toggling feature flag --> or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} Contribution counts from {% data variables.product.prodname_enterprise %} are considered private contributions. The commit details will only show the contribution counts and that these contributions were made in a {% data variables.product.prodname_enterprise %} environment outside of {% data variables.product.prodname_dotcom_the_website %}.
|
||||
Your {% data variables.product.prodname_dotcom_the_website %} profile shows {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %}<!-- Remove condition entirely when toggling feature flag --> or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} contribution counts from the past 90 days. {% data reusables.github-connect.sync-frequency %} Contribution counts from {% data variables.product.prodname_enterprise %} are considered private contributions. The commit details will only show the contribution counts and that these contributions were made in a {% data variables.product.prodname_enterprise %} environment outside of {% data variables.product.prodname_dotcom_the_website %}.
|
||||
|
||||
You can decide whether to show counts for private contributions on your profile. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile/)."
|
||||
|
||||
|
@ -29,15 +30,15 @@ For more information about how contributions are calculated, see "[Managing cont
|
|||
**Notes:**
|
||||
- The connection between your accounts is governed by <a href="/articles/github-privacy-statement/" class="dotcom-only">GitHub's Privacy Statement</a> and users enabling the connection agree to the <a href="/articles/github-terms-of-service/" class="dotcom-only">GitHub's Terms of Service</a>.
|
||||
|
||||
- Before you can connect your {% ifversion fpt %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %}<!-- Remove condition entirely when toggling feature flag --> or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} profile to your {% data variables.product.prodname_dotcom_the_website %} profile, your enterprise owner must enable {% data variables.product.prodname_github_connect %} and enable contribution sharing between the environments. For more information, contact your enterprise owner.
|
||||
- Before you can connect your {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %}<!-- Remove condition entirely when toggling feature flag --> or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} profile to your {% data variables.product.prodname_dotcom_the_website %} profile, your enterprise owner must enable {% data variables.product.prodname_github_connect %} and enable contribution sharing between the environments. For more information, contact your enterprise owner.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% ifversion fpt or ghes or ghae %}
|
||||
{% ifversion fpt or ghes or ghae or ghec %}
|
||||
|
||||
## Sending your enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
- To send enterprise contributions from {% data variables.product.prodname_ghe_server %} to your {% data variables.product.prodname_dotcom_the_website %} profile, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/enterprise-server/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)" in the {% data variables.product.prodname_ghe_server %} documentation.{% ifversion ghae-next %}<!-- Condition is within an fpt block; remove condition entirely when toggling feature flag -->
|
||||
- To send enterprise contributions from {% data variables.product.prodname_ghe_managed %} to your {% data variables.product.prodname_dotcom_the_website %} profile, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/github-ae@latest/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)" in the {% data variables.product.prodname_ghe_managed %} documentation.{% endif %}
|
||||
|
@ -65,4 +66,4 @@ For more information about how contributions are calculated, see "[Managing cont
|
|||
|
||||
{% endif %}
|
||||
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
shortTitle: Show an overview
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
shortTitle: Troubleshoot commits
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Viewing contributions on your profile
|
||||
intro: 'Your {% data variables.product.product_name %} profile shows off {% ifversion fpt or ghes %}your pinned repositories as well as{% endif %} a graph of your repository contributions over the past year.'
|
||||
intro: 'Your {% data variables.product.product_name %} profile shows off {% ifversion fpt or ghes or ghec %}your pinned repositories as well as{% endif %} a graph of your repository contributions over the past year.'
|
||||
redirect_from:
|
||||
- /articles/viewing-contributions/
|
||||
- /articles/viewing-contributions-on-your-profile-page/
|
||||
|
@ -11,11 +11,12 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
shortTitle: View contributions
|
||||
---
|
||||
{% ifversion fpt or ghes %}Your contribution graph shows activity from public repositories. {% endif %}You can choose to show activity from {% ifversion fpt or ghes %}both public and {% endif %}private repositories, with specific details of your activity in private repositories anonymized. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)."
|
||||
{% ifversion fpt or ghes or ghec %}Your contribution graph shows activity from public repositories. {% endif %}You can choose to show activity from {% ifversion fpt or ghes or ghec %}both public and {% endif %}private repositories, with specific details of your activity in private repositories anonymized. For more information, see "[Publicizing or hiding your private contributions on your profile](/articles/publicizing-or-hiding-your-private-contributions-on-your-profile)."
|
||||
|
||||
{% note %}
|
||||
|
||||
|
@ -39,11 +40,11 @@ On your profile page, certain actions count as contributions:
|
|||
|
||||
## Popular repositories
|
||||
|
||||
This section displays your repositories with the most watchers. {% ifversion fpt or ghes %}Once you [pin repositories to your profile](/articles/pinning-repositories-to-your-profile), this section will change to "Pinned repositories."{% endif %}
|
||||
This section displays your repositories with the most watchers. {% ifversion fpt or ghes or ghec %}Once you [pin repositories to your profile](/articles/pinning-repositories-to-your-profile), this section will change to "Pinned repositories."{% endif %}
|
||||
|
||||
![Popular repositories](/assets/images/help/profile/profile_popular_repositories.png)
|
||||
|
||||
{% ifversion fpt or ghes %}
|
||||
{% ifversion fpt or ghes or ghec %}
|
||||
|
||||
## Pinned repositories
|
||||
|
||||
|
@ -82,7 +83,7 @@ Timestamps are calculated differently for commits and pull requests:
|
|||
|
||||
![Activity overview section on profile](/assets/images/help/profile/activity-overview-section.png)
|
||||
|
||||
The organizations featured in the activity overview are prioritized according to how active you are in the organization. If you @mention an organization in your profile bio, and you’re an organization member, then that organization is prioritized first in the activity overview. For more information, see "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)” or "[Adding a bio to your profile](/articles/adding-a-bio-to-your-profile/)."
|
||||
The organizations featured in the activity overview are prioritized according to how active you are in the organization. If you @mention an organization in your profile bio, and you’re an organization member, then that organization is prioritized first in the activity overview. For more information, see "[Mentioning people and teams](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams)" or "[Adding a bio to your profile](/articles/adding-a-bio-to-your-profile/)."
|
||||
|
||||
## Contribution activity
|
||||
|
||||
|
@ -90,11 +91,11 @@ The contribution activity section includes a detailed timeline of your work, inc
|
|||
|
||||
![Contribution activity time filter](/assets/images/help/profile/contributions_activity_time_filter.png)
|
||||
|
||||
{% ifversion fpt or ghes or ghae-next %}
|
||||
{% ifversion fpt or ghes or ghae-next or ghec %}
|
||||
|
||||
## Viewing contributions from {% data variables.product.prodname_enterprise %} on {% data variables.product.prodname_dotcom_the_website %}
|
||||
|
||||
If you use {% ifversion fpt %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and your enterprise owner enables {% data variables.product.prodname_unified_contributions %}, you can send enterprise contribution counts from to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)."
|
||||
If you use {% ifversion fpt or ghec %}{% data variables.product.prodname_ghe_server %}{% ifversion ghae-next %} or {% data variables.product.prodname_ghe_managed %}{% endif %}{% else %}{% data variables.product.product_name %}{% endif %} and your enterprise owner enables {% data variables.product.prodname_unified_contributions %}, you can send enterprise contribution counts from to your {% data variables.product.prodname_dotcom_the_website %} profile. For more information, see "[Sending enterprise contributions to your {% data variables.product.prodname_dotcom_the_website %} profile](/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-graphs-on-your-profile/sending-enterprise-contributions-to-your-githubcom-profile)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Why are my contributions not showing up on my profile?
|
||||
intro: 'Learn common reasons that contributions may be missing from your contributions graph.'
|
||||
intro: Learn common reasons that contributions may be missing from your contributions graph.
|
||||
redirect_from:
|
||||
- /articles/why-are-my-contributions-not-showing-up-on-my-profile
|
||||
- /github/setting-up-and-managing-your-github-profile/why-are-my-contributions-not-showing-up-on-my-profile
|
||||
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Profiles
|
||||
shortTitle: Missing contributions
|
||||
|
@ -16,7 +17,7 @@ shortTitle: Missing contributions
|
|||
|
||||
## About your contribution graph
|
||||
|
||||
Your profile contributions graph is a record of contributions you've made to {% data variables.product.product_name %} repositories. Contributions are timestamped according to Coordinated Universal Time (UTC) rather than your local time zone. Contributions are only counted if they meet certain criteria. In some cases, we may need to rebuild your graph in order for contributions to appear.
|
||||
Your profile contributions graph is a record of contributions you've made to repositories {% ifversion ghae %}owned by{% else %}on{% endif %} {% data variables.product.product_location %}. Contributions are timestamped according to Coordinated Universal Time (UTC) rather than your local time zone. Contributions are only counted if they meet certain criteria. In some cases, we may need to rebuild your graph in order for contributions to appear.
|
||||
|
||||
## Contributions that are counted
|
||||
|
||||
|
@ -26,7 +27,7 @@ Issues, pull requests and discussions will appear on your contribution graph if
|
|||
|
||||
### Commits
|
||||
Commits will appear on your contributions graph if they meet **all** of the following conditions:
|
||||
- The email address used for the commits is associated with your {% data variables.product.product_name %} account.
|
||||
- The email address used for the commits is associated with your account on {% data variables.product.product_location %}.
|
||||
- The commits were made in a standalone repository, not a fork.
|
||||
- The commits were made:
|
||||
- In the repository's default branch
|
||||
|
@ -50,7 +51,7 @@ After making a commit that meets the requirements to count as a contribution, yo
|
|||
|
||||
### Your local Git commit email isn't connected to your account
|
||||
|
||||
Commits must be made with an email address that is connected to your account on {% data variables.product.product_name %}{% ifversion fpt %}, or the {% data variables.product.product_name %}-provided `noreply` email address provided to you in your email settings,{% endif %} in order to appear on your contributions graph.{% ifversion fpt %} For more information about `noreply` email addresses, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#about-commit-email-addresses)."{% endif %}
|
||||
Commits must be made with an email address that is connected to your account on {% data variables.product.product_location %}{% ifversion fpt or ghec %}, or the {% data variables.product.prodname_dotcom %}-provided `noreply` email address provided to you in your email settings,{% endif %} in order to appear on your contributions graph.{% ifversion fpt or ghec %} For more information about `noreply` email addresses, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#about-commit-email-addresses)."{% endif %}
|
||||
|
||||
You can check the email address used for a commit by adding `.patch` to the end of a commit URL, e.g. <a href="https://github.com/octocat/octocat.github.io/commit/67c0afc1da354d8571f51b6f0af8f2794117fd10.patch" data-proofer-ignore>https://github.com/octocat/octocat.github.io/commit/67c0afc1da354d8571f51b6f0af8f2794117fd10.patch</a>:
|
||||
|
||||
|
@ -63,11 +64,11 @@ Subject: [PATCH] updated index for better welcome message
|
|||
|
||||
The email address in the `From:` field is the address that was set in the [local git config settings](/articles/set-up-git). In this example, the email address used for the commit is `octocat@nowhere.com`.
|
||||
|
||||
If the email address used for the commit is not connected to your account on {% data variables.product.product_name %}, {% ifversion ghae %}change the email address used to author commits in Git. For more information, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %}you must [add the email address](/articles/adding-an-email-address-to-your-github-account) to your {% data variables.product.product_name %} account. Your contributions graph will be rebuilt automatically when you add the new address.{% endif %}
|
||||
If the email address used for the commit is not connected to your account on {% data variables.product.product_location %}, {% ifversion ghae %}change the email address used to author commits in Git. For more information, see "[Setting your commit email address](/github/setting-up-and-managing-your-github-user-account/setting-your-commit-email-address#setting-your-commit-email-address-in-git)."{% else %}you must [add the email address](/articles/adding-an-email-address-to-your-github-account) to your account on {% data variables.product.product_location %}. Your contributions graph will be rebuilt automatically when you add the new address.{% endif %}
|
||||
|
||||
{% warning %}
|
||||
|
||||
Generic email addresses--such as `jane@computer.local`--cannot be added to {% data variables.product.product_name %} accounts. If you use such an email for your commits, the commits will not be linked to your {% data variables.product.product_name %} profile and will not show up in your contributions graph.
|
||||
**Warning**: Generic email addresses, such as `jane@computer.local`, cannot be added to {% data variables.product.prodname_dotcom %} accounts. If you use such an email for your commits, the commits will not be linked to your {% data variables.product.prodname_dotcom %} profile and will not show up in your contribution graph.
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
|
@ -81,7 +82,7 @@ If your commits are in a non-default or non-`gh-pages` branch and you'd like the
|
|||
|
||||
{% warning %}
|
||||
|
||||
Changing the default branch of the repository will change it for all repository collaborators. Only do this if you want the new branch to become the base against which all future pull requests and commits will be made.
|
||||
**Warning**: Changing the default branch of the repository will change it for all repository collaborators. Only do this if you want the new branch to become the base against which all future pull requests and commits will be made.
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
|
@ -89,7 +90,7 @@ Changing the default branch of the repository will change it for all repository
|
|||
|
||||
Commits made in a fork will not count toward your contributions. To make them count, you must do one of the following:
|
||||
- [Open a pull request](/articles/creating-a-pull-request) to have your changes merged into the parent repository.
|
||||
- To detach the fork and turn it into a standalone repository on {% data variables.product.product_name %}, contact {% data variables.contact.contact_support %}. If the fork has forks of its own, let {% data variables.contact.github_support %} know if the forks should move with your repository into a new network or remain in the current network. For more information, see "[About forks](/articles/about-forks/)."
|
||||
- To detach the fork and turn it into a standalone repository on {% data variables.product.product_location %}, contact {% data variables.contact.contact_support %}. If the fork has forks of its own, let {% data variables.contact.contact_support %} know if the forks should move with your repository into a new network or remain in the current network. For more information, see "[About forks](/articles/about-forks/)."
|
||||
|
||||
## Further reading
|
||||
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
children:
|
||||
|
|
|
@ -11,6 +11,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Repositories
|
||||
|
|
|
@ -1,27 +1,28 @@
|
|||
---
|
||||
title: Inviting collaborators to a personal repository
|
||||
intro: 'You can {% ifversion fpt %}invite users to become{% else %}add users as{% endif %} collaborators to your personal repository.'
|
||||
intro: 'You can {% ifversion fpt or ghec %}invite users to become{% else %}add users as{% endif %} collaborators to your personal repository.'
|
||||
redirect_from:
|
||||
- /articles/how-do-i-add-a-collaborator/
|
||||
- /articles/adding-collaborators-to-a-personal-repository/
|
||||
- /articles/inviting-collaborators-to-a-personal-repository
|
||||
- /github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository
|
||||
- /github/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository
|
||||
product: '{% data reusables.gated-features.user-repo-collaborators %}'
|
||||
product: '{% ifversion fpt %}{% data reusables.gated-features.user-repo-collaborators %}{% endif %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Repositories
|
||||
shortTitle: Invite collaborators
|
||||
---
|
||||
Repositories owned by an organization can grant more granular access. For more information, see "[Access permissions on {% data variables.product.product_name %}](/articles/access-permissions-on-github)."
|
||||
Repositories owned by an organization can grant more granular access. For more information, see "[Access permissions on {% data variables.product.prodname_dotcom %}](/articles/access-permissions-on-github)."
|
||||
|
||||
{% data reusables.organizations.org-invite-expiration %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you can only invite other members of your enterprise to collaborate with you. {% data reusables.enterprise-accounts.emu-more-info-account %}
|
||||
|
||||
|
@ -33,10 +34,10 @@ If you're a member of an {% data variables.product.prodname_emu_enterprise %}, y
|
|||
|
||||
{% endif %}
|
||||
|
||||
1. Ask for the username of the person you're inviting as a collaborator.{% ifversion fpt %} If they don't have a username yet, they can sign up for {% data variables.product.prodname_dotcom %} For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account)".{% endif %}
|
||||
1. Ask for the username of the person you're inviting as a collaborator.{% ifversion fpt or ghec %} If they don't have a username yet, they can sign up for {% data variables.product.prodname_dotcom %} For more information, see "[Signing up for a new {% data variables.product.prodname_dotcom %} account](/articles/signing-up-for-a-new-github-account)".{% endif %}
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
{% data reusables.repositories.navigate-to-manage-access %}
|
||||
1. Click **Invite a collaborator**.
|
||||
!["Invite a collaborator" button](/assets/images/help/repository/invite-a-collaborator-button.png)
|
||||
|
@ -53,7 +54,7 @@ If you're a member of an {% data variables.product.prodname_emu_enterprise %}, y
|
|||
8. Click **Add collaborator**.
|
||||
!["Add collaborator" button](/assets/images/help/repository/repo-settings-collab-add.png)
|
||||
{% endif %}
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
9. The user will receive an email inviting them to the repository. Once they accept your invitation, they will have collaborator access to your repository.
|
||||
{% endif %}
|
||||
|
||||
|
|
|
@ -3,6 +3,7 @@ title: Maintaining ownership continuity of your user account's repositories
|
|||
intro: You can invite someone to manage your user owned repositories if you are not able to.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Repositories
|
||||
|
@ -21,7 +22,7 @@ We recommend inviting another {% data variables.product.company_short %} user to
|
|||
|
||||
Successors cannot log into your account.
|
||||
|
||||
An appointed successor can manage your public repositories after presenting a death certificate then waiting for 7 days or presenting an obituary then waiting for 21 days. For more information, see “[{% data variables.product.company_short %} Deceased User Policy](/github/site-policy/github-deceased-user-policy)."
|
||||
An appointed successor can manage your public repositories after presenting a death certificate then waiting for 7 days or presenting an obituary then waiting for 21 days. For more information, see "[{% data variables.product.company_short %} Deceased User Policy](/free-pro-team@latest/github/site-policy/github-deceased-user-policy)."
|
||||
|
||||
To request access to manage repositories as a successor, contact [GitHub Support](https://support.github.com/contact?tags=docs-accounts).
|
||||
|
||||
|
|
|
@ -15,6 +15,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Repositories
|
||||
|
@ -28,7 +29,7 @@ While forks of private repositories are deleted when a collaborator is removed,
|
|||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
{% data reusables.repositories.sidebar-settings %}
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
{% data reusables.repositories.navigate-to-manage-access %}
|
||||
4. To the right of the collaborator you want to remove, click {% octicon "trash" aria-label="The trash icon" %}.
|
||||
![Button to remove collaborator](/assets/images/help/repository/collaborator-remove.png)
|
||||
|
|
|
@ -14,6 +14,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Repositories
|
||||
|
|
|
@ -8,12 +8,13 @@ redirect_from:
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Notifications
|
||||
shortTitle: Add an email address
|
||||
---
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
{% note %}
|
||||
|
||||
|
|
|
@ -7,6 +7,7 @@ redirect_from:
|
|||
- /github/setting-up-and-managing-your-github-user-account/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Notifications
|
||||
|
|
|
@ -8,6 +8,7 @@ redirect_from:
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Notifications
|
||||
|
@ -26,10 +27,6 @@ shortTitle: Primary email address
|
|||
4. Under "Primary email address", use the drop-down menu to click the email address you'd like to set as your primary email address, and click **Save**.
|
||||
![Set as primary button](/assets/images/help/settings/set_as_primary_email.png)
|
||||
5. To remove the old email address from your account, next to the old email, click {% octicon "trash" aria-label="The trash symbol" %}.
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
6. Verify your new primary email address. Without a verified email address, you won't be able to use all of {% data variables.product.product_name %}'s features. For more information, see "[Verifying your email address](/articles/verifying-your-email-address)."
|
||||
{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- "[Managing email preferences](/articles/managing-email-preferences/)"
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Managing email preferences
|
||||
intro: 'You can add or change the email addresses associated with your {% data variables.product.product_name %} account. You can also manage emails you receive from {% data variables.product.product_name %}.'
|
||||
intro: 'You can add or change the email addresses associated with your account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. You can also manage emails you receive from {% data variables.product.product_name %}.'
|
||||
redirect_from:
|
||||
- /categories/managing-email-preferences/
|
||||
- /articles/managing-email-preferences
|
||||
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Notifications
|
||||
|
|
|
@ -7,6 +7,7 @@ redirect_from:
|
|||
- /github/setting-up-and-managing-your-github-user-account/managing-email-preferences/managing-marketing-emails-from-github
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Notifications
|
||||
|
|
|
@ -10,6 +10,7 @@ redirect_from:
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Notifications
|
||||
|
@ -67,7 +68,7 @@ origin https://{% data variables.command_line.codeblock %}/<em>YOUR_USERNAME</em
|
|||
|
||||
Your user name is what immediately follows the `https://{% data variables.command_line.backticks %}/`.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
## Further reading
|
||||
|
||||
- "[Verifying your email address](/articles/verifying-your-email-address)"
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Notifications
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Setting your commit email address
|
||||
intro: 'You can set the email address that is used to author commits on {% data variables.product.product_name %} and on your computer.'
|
||||
intro: 'You can set the email address that is used to author commits on {% data variables.product.product_location %} and on your computer.'
|
||||
redirect_from:
|
||||
- /articles/keeping-your-email-address-private/
|
||||
- /articles/setting-your-commit-email-address-on-github/
|
||||
|
@ -16,6 +16,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Notifications
|
||||
|
@ -23,13 +24,13 @@ shortTitle: Set commit email address
|
|||
---
|
||||
## About commit email addresses
|
||||
|
||||
{% data variables.product.product_name %} uses your commit email address to associate commits with your {% data variables.product.product_name %} account. You can choose the email address that will be associated with the commits you push from the command line as well as web-based Git operations you make.
|
||||
{% data variables.product.prodname_dotcom %} uses your commit email address to associate commits with your account on {% data variables.product.product_location %}. You can choose the email address that will be associated with the commits you push from the command line as well as web-based Git operations you make.
|
||||
|
||||
For web-based Git operations, you can set your commit email address on {% data variables.product.product_name %}. For commits you push from the command line, you can set your commit email address in Git.
|
||||
For web-based Git operations, you can set your commit email address on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}. For commits you push from the command line, you can set your commit email address in Git.
|
||||
|
||||
{% ifversion fpt %}Any commits you made prior to changing your commit email address are still associated with your previous email address.{% else %}After changing your commit email address on {% data variables.product.product_name %}, the new email address will be visible in all of your future web-based Git operations by default. Any commits you made prior to changing your commit email address are still associated with your previous email address.{% endif %}
|
||||
{% ifversion fpt or ghec %}Any commits you made prior to changing your commit email address are still associated with your previous email address.{% else %}After changing your commit email address on {% data variables.product.product_name %}, the new email address will be visible in all of your future web-based Git operations by default. Any commits you made prior to changing your commit email address are still associated with your previous email address.{% endif %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
{% note %}
|
||||
|
||||
|
@ -39,21 +40,21 @@ For web-based Git operations, you can set your commit email address on {% data v
|
|||
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt %}If you'd like to keep your personal email address private, you can use a {% data variables.product.product_name %}-provided `no-reply` email address as your commit email address. To use your `noreply` email address for commits you push from the command line, use that email address when you set your commit email address in Git. To use your `noreply` address for web-based Git operations, set your commit email address on GitHub and choose to **Keep my email address private**.
|
||||
{% ifversion fpt or ghec %}If you'd like to keep your personal email address private, you can use a `no-reply` email address from {% data variables.product.product_name %} as your commit email address. To use your `noreply` email address for commits you push from the command line, use that email address when you set your commit email address in Git. To use your `noreply` address for web-based Git operations, set your commit email address on GitHub and choose to **Keep my email address private**.
|
||||
|
||||
You can also choose to block commits you push from the command line that expose your personal email address. For more information, see "[Blocking command line pushes that expose your personal email](/articles/blocking-command-line-pushes-that-expose-your-personal-email-address)."{% endif %}
|
||||
|
||||
To ensure that commits are attributed to you and appear in your contributions graph, use an email address that is connected to your {% data variables.product.product_name %} account{% ifversion fpt %}, or the `noreply` email address provided to you in your email settings{% endif %}. {% ifversion not ghae %}For more information, see "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account)."{% endif %}
|
||||
To ensure that commits are attributed to you and appear in your contributions graph, use an email address that is connected to your account on {% data variables.product.product_location %}{% ifversion fpt or ghec %}, or the `noreply` email address provided to you in your email settings{% endif %}. {% ifversion not ghae %}For more information, see "[Adding an email address to your {% data variables.product.prodname_dotcom %} account](/github/setting-up-and-managing-your-github-user-account/adding-an-email-address-to-your-github-account)."{% endif %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** If you created your {% data variables.product.product_name %} account _after_ July 18, 2017, your {% data variables.product.product_name %}-provided `no-reply` email address is a seven-digit ID number and your username in the form of <code><em>ID+username</em>@users.noreply.github.com</code>. If you created your {% data variables.product.product_name %} account _prior to_ July 18, 2017, your {% data variables.product.product_name %}-provided `no-reply` email address is your username in the form of <code><em>username</em>@users.noreply.github.com</code>. You can get an ID-based {% data variables.product.product_name %}-provided `no-reply` email address by selecting (or deselecting and reselecting) **Keep my email address private** in your email settings.
|
||||
**Note:** If you created your account on {% data variables.product.product_location %} _after_ July 18, 2017, your `no-reply` email address for {% data variables.product.product_name %} is a seven-digit ID number and your username in the form of <code><em>ID+username</em>@users.noreply.github.com</code>. If you created your account on {% data variables.product.product_location %} _prior to_ July 18, 2017, your `no-reply` email address from {% data variables.product.product_name %} is <code><em>username</em>@users.noreply.github.com</code>. You can get an ID-based `no-reply` email address for {% data variables.product.product_name %} by selecting (or deselecting and reselecting) **Keep my email address private** in your email settings.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
If you use your {% data variables.product.product_name %}-provided `noreply` email address to make commits and then [change your username](/articles/changing-your-github-username), those commits will not be associated with your {% data variables.product.product_name %} account. This does not apply if you're using the ID-based {% data variables.product.product_name %}-provided `noreply` address. For more information, see "[Changing your {% data variables.product.prodname_dotcom %} username](/articles/changing-your-github-username)."{% endif %}
|
||||
If you use your `noreply` email address for {% data variables.product.product_name %} to make commits and then [change your username](/articles/changing-your-github-username), those commits will not be associated with your account on {% data variables.product.product_location %}. This does not apply if you're using the ID-based `noreply` address from {% data variables.product.product_name %}. For more information, see "[Changing your {% data variables.product.prodname_dotcom %} username](/articles/changing-your-github-username)."{% endif %}
|
||||
|
||||
## Setting your commit email address on {% data variables.product.prodname_dotcom %}
|
||||
|
||||
|
@ -62,12 +63,12 @@ If you use your {% data variables.product.product_name %}-provided `noreply` ema
|
|||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.emails %}
|
||||
{% data reusables.user_settings.add_and_verify_email %}
|
||||
{% data reusables.user_settings.select_primary_email %}{% ifversion fpt %}
|
||||
{% data reusables.user_settings.select_primary_email %}{% ifversion fpt or ghec %}
|
||||
{% data reusables.user_settings.keeping_your_email_address_private %}{% endif %}
|
||||
|
||||
## Setting your commit email address in Git
|
||||
|
||||
You can use the `git config` command to change the email address you associate with your Git commits. The new email address you set will be visible in any future commits you push to {% data variables.product.product_name %} from the command line. Any commits you made prior to changing your commit email address are still associated with your previous email address.
|
||||
You can use the `git config` command to change the email address you associate with your Git commits. The new email address you set will be visible in any future commits you push to {% data variables.product.product_location %} from the command line. Any commits you made prior to changing your commit email address are still associated with your previous email address.
|
||||
|
||||
### Setting your email address for every repository on your computer
|
||||
|
||||
|
@ -85,7 +86,7 @@ You can use the `git config` command to change the email address you associate w
|
|||
|
||||
### Setting your email address for a single repository
|
||||
|
||||
{% data variables.product.product_name %} uses the email address set in your local Git configuration to associate commits pushed from the command line with your {% data variables.product.product_name %} account.
|
||||
{% data variables.product.product_name %} uses the email address set in your local Git configuration to associate commits pushed from the command line with your account on {% data variables.product.product_location %}.
|
||||
|
||||
You can change the email address associated with commits you make in a single repository. This will override your global Git config settings in this one repository, but will not affect any other repositories.
|
||||
|
||||
|
|
|
@ -7,6 +7,7 @@ redirect_from:
|
|||
- /github/setting-up-and-managing-your-github-user-account/managing-email-preferences/types-of-emails-github-sends
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
- Notifications
|
||||
|
|
|
@ -11,6 +11,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Your personal dashboard
|
||||
|
@ -43,10 +44,10 @@ In the "All activity" section of your news feed, you can view updates from repos
|
|||
|
||||
You'll see updates in your news feed when a user you follow:
|
||||
- Stars a repository.
|
||||
- Follows another user.{% ifversion fpt or ghes %}
|
||||
- Follows another user.{% ifversion fpt or ghes or ghec %}
|
||||
- Creates a public repository.{% endif %}
|
||||
- Opens an issue or pull request with "help wanted" or "good first issue" label on a repository you're watching.
|
||||
- Pushes commits to a repository you watch.{% ifversion fpt or ghes %}
|
||||
- Pushes commits to a repository you watch.{% ifversion fpt or ghes or ghec %}
|
||||
- Forks a public repository.{% endif %}
|
||||
- Publishes a new release.
|
||||
|
||||
|
@ -54,7 +55,7 @@ For more information about starring repositories and following people, see "[Sav
|
|||
|
||||
## Exploring recommended repositories
|
||||
|
||||
In the "Explore repositories" section on the right side of your dashboard, you can explore recommended repositories in your communities. Recommendations are based on repositories you've starred or visited, the people you follow, and activity within repositories that you have access to.{% ifversion fpt %} For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)."{% endif %}
|
||||
In the "Explore repositories" section on the right side of your dashboard, you can explore recommended repositories in your communities. Recommendations are based on repositories you've starred or visited, the people you follow, and activity within repositories that you have access to.{% ifversion fpt or ghec %} For more information, see "[Finding ways to contribute to open source on {% data variables.product.prodname_dotcom %}](/github/getting-started-with-github/finding-ways-to-contribute-to-open-source-on-github)."{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
||||
|
|
|
@ -7,6 +7,7 @@ redirect_from:
|
|||
- /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/best-practices-for-leaving-your-company
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Leaving your company
|
||||
|
@ -15,7 +16,7 @@ Before you leave your company, make sure you update the following information in
|
|||
|
||||
- Unverify your company email address by [deleting it in your Email settings](/articles/changing-your-primary-email-address). You can then re-add it without verifying to keep any associated commits linked to your account.
|
||||
- [Change your primary email address](/articles/changing-your-primary-email-address) from your company email to your personal email.
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
- [Verify your new primary email address](/articles/verifying-your-email-address).
|
||||
{% endif %}
|
||||
- [Change your GitHub username](/articles/changing-your-github-username) to remove any references to your company or organization, if necessary.
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Changing your GitHub username
|
||||
intro: 'You can change your {% data variables.product.product_name %} username at any time.'
|
||||
intro: 'You can change the username for your account on {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom_the_website %}{% elsif ghes %}{% data variables.product.product_location %} if your instance uses built-in authentication{% endif %}.'
|
||||
redirect_from:
|
||||
- /articles/how-to-change-your-username/
|
||||
- /articles/changing-your-github-user-name/
|
||||
|
@ -12,15 +12,35 @@ redirect_from:
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Change your username
|
||||
---
|
||||
|
||||
{% ifversion ghec or ghes %}
|
||||
|
||||
{% note %}
|
||||
|
||||
{% ifversion ghec %}
|
||||
|
||||
**Note**: Members of an {% data variables.product.prodname_emu_enterprise %} cannot change usernames. Your enterprise's IdP administrator controls your username for {% data variables.product.product_name %}. For more information, see "[About {% data variables.product.prodname_emus %}](/admin/authentication/managing-your-enterprise-users-with-your-identity-provider/about-enterprise-managed-users)."
|
||||
|
||||
{% elsif ghes %}
|
||||
|
||||
**Note**: If you sign into {% data variables.product.product_location %} with LDAP credentials or single sign-on (SSO), only your local administrator can change your username. For more information about authentication methods for {% data variables.product.product_name %}, see "[Authenticating users for {% data variables.product.product_location %}](/admin/authentication/authenticating-users-for-your-github-enterprise-server-instance)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% endif %}
|
||||
|
||||
## About username changes
|
||||
|
||||
You can change your username to another username that is not currently in use.{% ifversion fpt %} If the username you want is not available, consider other names or unique variations. Using a number, hyphen, or an alternative spelling might help you find a similar username that's still available.
|
||||
You can change your username to another username that is not currently in use.{% ifversion fpt or ghec %} If the username you want is not available, consider other names or unique variations. Using a number, hyphen, or an alternative spelling might help you find a similar username that's still available.
|
||||
|
||||
If you hold a trademark for the username, you can find more information about making a trademark complaint on our [Trademark Policy](/articles/github-trademark-policy/) page.
|
||||
If you hold a trademark for the username, you can find more information about making a trademark complaint on our [Trademark Policy](/free-pro-team@latest/github/site-policy/github-trademark-policy) page.
|
||||
|
||||
If you do not hold a trademark for the name, you can choose another username or keep your current username. {% data variables.contact.github_support %} cannot release the unavailable username for you. For more information, see "[Changing your username](#changing-your-username)."{% endif %}
|
||||
|
||||
|
@ -30,7 +50,7 @@ After changing your username, your old username becomes available for anyone els
|
|||
- [@mentions](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams) using your old username
|
||||
- Links to [gists](/articles/creating-gists) that include your old username
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
If you're a member of an {% data variables.product.prodname_emu_enterprise %}, you cannot make changes to your username. {% data reusables.enterprise-accounts.emu-more-info-account %}
|
||||
|
||||
|
@ -46,18 +66,18 @@ If the new owner of your old username creates a repository with the same name as
|
|||
|
||||
## Links to your previous profile page
|
||||
|
||||
After changing your username, links to your previous profile page, such as `https://{% data variables.command_line.backticks %}/previoususername`, will return a 404 error. We recommend updating any links to your {% data variables.product.product_name %} account from elsewhere{% ifversion fpt %}, such as your LinkedIn or Twitter profile{% endif %}.
|
||||
After changing your username, links to your previous profile page, such as `https://{% data variables.command_line.backticks %}/previoususername`, will return a 404 error. We recommend updating any links to your account on {% data variables.product.product_location %} from elsewhere{% ifversion fpt or ghec %}, such as your LinkedIn or Twitter profile{% endif %}.
|
||||
|
||||
## Your Git commits
|
||||
|
||||
{% ifversion fpt %}Git commits that were associated with your {% data variables.product.product_name %}-provided `noreply` email address won't be attributed to your new username and won't appear in your contributions graph.{% endif %} If your Git commits are associated with another email address you've [added to your GitHub account](/articles/adding-an-email-address-to-your-github-account), {% ifversion fpt %}including the ID-based {% data variables.product.product_name %}-provided `noreply` email address, {% endif %}they'll continue to be attributed to you and appear in your contributions graph after you've changed your username. For more information on setting your email address, see "[Setting your commit email address](/articles/setting-your-commit-email-address)."
|
||||
{% ifversion fpt or ghec %}Git commits that were associated with your {% data variables.product.product_name %}-provided `noreply` email address won't be attributed to your new username and won't appear in your contributions graph.{% endif %} If your Git commits are associated with another email address you've [added to your GitHub account](/articles/adding-an-email-address-to-your-github-account), {% ifversion fpt or ghec %}including the ID-based {% data variables.product.product_name %}-provided `noreply` email address, {% endif %}they'll continue to be attributed to you and appear in your contributions graph after you've changed your username. For more information on setting your email address, see "[Setting your commit email address](/articles/setting-your-commit-email-address)."
|
||||
|
||||
## Changing your username
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.account_settings %}
|
||||
3. In the "Change username" section, click **Change username**.
|
||||
![Change Username button](/assets/images/help/settings/settings-change-username.png){% ifversion fpt %}
|
||||
![Change Username button](/assets/images/help/settings/settings-change-username.png){% ifversion fpt or ghec %}
|
||||
4. Read the warnings about changing your username. If you still want to change your username, click **I understand, let's change my username**.
|
||||
![Change Username warning button](/assets/images/help/settings/settings-change-username-warning-button.png)
|
||||
5. Type a new username.
|
||||
|
@ -68,5 +88,5 @@ After changing your username, links to your previous profile page, such as `http
|
|||
|
||||
## Further reading
|
||||
|
||||
- "[Why are my commits linked to the wrong user?](/articles/why-are-my-commits-linked-to-the-wrong-user)"{% ifversion fpt %}
|
||||
- "[{% data variables.product.prodname_dotcom %} Username Policy](/articles/github-username-policy)"{% endif %}
|
||||
- "[Why are my commits linked to the wrong user?](/articles/why-are-my-commits-linked-to-the-wrong-user)"{% ifversion fpt or ghec %}
|
||||
- "[{% data variables.product.prodname_dotcom %} Username Policy](/free-pro-team@latest/github/site-policy/github-username-policy)"{% endif %}
|
||||
|
|
|
@ -10,6 +10,7 @@ intro: You can convert your user account into an organization. This allows more
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: User into an organization
|
||||
|
@ -40,7 +41,7 @@ If you want your organization to have the same name that you are currently using
|
|||
You can also convert your personal user account directly into an organization. Converting your account:
|
||||
- Preserves the repositories as they are without the need to transfer them to another account manually
|
||||
- Automatically invites collaborators to teams with permissions equivalent to what they had before
|
||||
{% ifversion fpt %}- For user accounts on {% data variables.product.prodname_pro %}, automatically transitions billing to [the paid {% data variables.product.prodname_team %}](/articles/about-billing-for-github-accounts) without the need to re-enter payment information, adjust your billing cycle, or double pay at any time{% endif %}
|
||||
{% ifversion fpt or ghec %}- For user accounts on {% data variables.product.prodname_pro %}, automatically transitions billing to [the paid {% data variables.product.prodname_team %}](/articles/about-billing-for-github-accounts) without the need to re-enter payment information, adjust your billing cycle, or double pay at any time{% endif %}
|
||||
|
||||
1. Create a new personal account, which you'll use to sign into GitHub and access the organization and your repositories after you convert.
|
||||
2. [Leave any organizations](/articles/removing-yourself-from-an-organization) the user account you're converting has joined.
|
||||
|
@ -64,5 +65,5 @@ You can also convert your personal user account directly into an organization. C
|
|||
|
||||
## Further reading
|
||||
- "[Setting up teams](/articles/setting-up-teams)"
|
||||
{% ifversion fpt %}- "[Inviting users to join your organization](/articles/inviting-users-to-join-your-organization)"{% endif %}
|
||||
{% ifversion fpt or ghec %}- "[Inviting users to join your organization](/articles/inviting-users-to-join-your-organization)"{% endif %}
|
||||
- "[Accessing an organization](/articles/accessing-an-organization)"
|
||||
|
|
|
@ -9,13 +9,14 @@ redirect_from:
|
|||
versions:
|
||||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Delete your user account
|
||||
---
|
||||
Deleting your user account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt %} Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted - instead, they'll be associated with our [Ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %}
|
||||
Deleting your user account removes all repositories, forks of private repositories, wikis, issues, pull requests, and pages owned by your account. {% ifversion fpt or ghec %} Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted - instead, they'll be associated with our [Ghost user](https://github.com/ghost).{% else %}Issues and pull requests you've created and comments you've made in repositories owned by other users will not be deleted.{% endif %}
|
||||
|
||||
{% ifversion fpt %} The account name also becomes available to anyone else to use on a new account, and we stop billing you. The email address associated with the account becomes available for use with a different {% data variables.product.product_name %} account. {% endif %}
|
||||
{% ifversion fpt or ghec %} The account name also becomes available to anyone else to use on a new account, and we stop billing you. The email address associated with the account becomes available for use with a different account on {% data variables.product.product_location %}. {% endif %}
|
||||
|
||||
If you’re the only owner of an organization, you must transfer ownership to another person or delete the organization before you can delete your user account. If there are other owners in the organization, you must remove yourself from the organization before you can delete your user account.
|
||||
|
||||
|
@ -44,7 +45,7 @@ Before you delete your user account, make a copy of all repositories, private fo
|
|||
![Account deletion button](/assets/images/help/settings/settings-account-delete.png)
|
||||
4. In the "Make sure you want to do this" dialog box, complete the steps to confirm you understand what happens when your account is deleted:
|
||||
![Delete account confirmation dialog](/assets/images/help/settings/settings-account-deleteconfirm.png)
|
||||
{% ifversion fpt %}- Recall that all repositories, forks of private repositories, wikis, issues, pull requests and pages owned by your account will be deleted, your billing will end, and your username will be available to anyone for use on {% data variables.product.product_name %}.
|
||||
{% ifversion fpt or ghec %}- Recall that all repositories, forks of private repositories, wikis, issues, pull requests and pages owned by your account will be deleted, your billing will end, and your username will be available to anyone for use on {% data variables.product.product_name %}.
|
||||
{% else %}- Recall that all repositories, forks of private repositories, wikis, issues, pull requests and pages owned by your account will be deleted, and your username will be available for use on {% data variables.product.product_name %}.
|
||||
{% endif %}- In the first field, type your {% data variables.product.product_name %} username or email.
|
||||
- In the second field, type the phrase from the prompt.
|
||||
|
|
|
@ -10,6 +10,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
children:
|
||||
|
|
|
@ -11,6 +11,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Manage access project boards
|
||||
|
|
|
@ -3,6 +3,7 @@ title: Managing security and analysis settings for your user account
|
|||
intro: 'You can control features that secure and analyze the code in your projects on {% data variables.product.prodname_dotcom %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
redirect_from:
|
||||
|
@ -46,4 +47,4 @@ For an overview of repository-level security, see "[Securing your repository](/c
|
|||
|
||||
- "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)"
|
||||
- "[Managing vulnerabilities in your project's dependencies](/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies)"
|
||||
{% ifversion fpt %}- "[Keeping your dependencies updated automatically](/github/administering-a-repository/keeping-your-dependencies-updated-automatically)"{% endif %}
|
||||
{% ifversion fpt or ghec %}- "[Keeping your dependencies updated automatically](/github/administering-a-repository/keeping-your-dependencies-updated-automatically)"{% endif %}
|
||||
|
|
|
@ -5,6 +5,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '>=3.0'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
redirect_from:
|
||||
|
|
|
@ -3,6 +3,7 @@ title: Managing your tab size rendering preference
|
|||
intro: 'You can manage the number of spaces a tab is equal to for your user account.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Managing your tab size
|
||||
|
|
|
@ -3,8 +3,9 @@ title: Managing your theme settings
|
|||
intro: 'You can manage how {% data variables.product.product_name %} looks to you by setting a theme preference that either follows your system settings or always uses a light or dark mode.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghae: 'next'
|
||||
ghae: next
|
||||
ghes: '>=3.2'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
redirect_from:
|
||||
|
@ -17,7 +18,7 @@ For choice and flexibility in how and when you use {% data variables.product.pro
|
|||
|
||||
You may want to use a dark theme to reduce power consumption on certain devices, to reduce eye strain in low-light conditions, or because you prefer how the theme looks.
|
||||
|
||||
{% ifversion fpt or ghae-issue-4618 %} If you have low vision, you may benefit from a high contrast theme, with greater contrast between foreground and background elements.{% endif %}{% ifversion fpt or ghae-issue-4619 %} If you have colorblindness, you may benefit from our light and dark colorblind themes.
|
||||
{% ifversion fpt or ghae-issue-4618 or ghec %} If you have low vision, you may benefit from a high contrast theme, with greater contrast between foreground and background elements.{% endif %}{% ifversion fpt or ghae-issue-4619 or ghec %} If you have colorblindness, you may benefit from our light and dark colorblind themes.
|
||||
|
||||
{% note %}
|
||||
|
||||
|
@ -32,10 +33,10 @@ You may want to use a dark theme to reduce power consumption on certain devices,
|
|||
![Drop-down menu under "Theme mode" for selection of theme preference](/assets/images/help/settings/theme-mode-drop-down-menu.png)
|
||||
3. Click the theme you'd like to use.
|
||||
- If you chose a single theme, click a theme.
|
||||
{% ifversion fpt or ghae-issue-4618 %}![Radio buttons for the choice of a single theme](/assets/images/help/settings/theme-choose-a-single-theme-highcontrast.png){% else %}![Radio buttons for the choice of a single theme](/assets/images/help/settings/theme-choose-a-single-theme.png){% endif %}
|
||||
{% ifversion fpt or ghae-issue-4618 or ghec %}![Radio buttons for the choice of a single theme](/assets/images/help/settings/theme-choose-a-single-theme-highcontrast.png){% else %}![Radio buttons for the choice of a single theme](/assets/images/help/settings/theme-choose-a-single-theme.png){% endif %}
|
||||
- If you chose to follow your system settings, click a day theme and a night theme.
|
||||
{% ifversion fpt or ghae-issue-4618 %}![Buttons for the choice of a theme to sync with the system setting](/assets/images/help/settings/theme-choose-a-day-and-night-theme-to-sync-highcontrast.png){% else %}![Buttons for the choice of a theme to sync with the system setting](/assets/images/help/settings/theme-choose-a-day-and-night-theme-to-sync.png){% endif %}
|
||||
{% ifversion fpt or ghae-issue-4619 %}
|
||||
{% ifversion fpt or ghae-issue-4618 or ghec %}![Buttons for the choice of a theme to sync with the system setting](/assets/images/help/settings/theme-choose-a-day-and-night-theme-to-sync-highcontrast.png){% else %}![Buttons for the choice of a theme to sync with the system setting](/assets/images/help/settings/theme-choose-a-day-and-night-theme-to-sync.png){% endif %}
|
||||
{% ifversion fpt or ghae-issue-4619 or ghec %}
|
||||
- If you would like to choose a theme which is currently in public beta, you will first need to enable it with feature preview. For more information, see "[Exploring early access releases with feature preview](/get-started/using-github/exploring-early-access-releases-with-feature-preview)."{% endif %}
|
||||
|
||||
## Further reading
|
||||
|
|
|
@ -9,6 +9,7 @@ redirect_from:
|
|||
- /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/merging-multiple-user-accounts
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Merge multiple user accounts
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Permission user repositories
|
||||
|
@ -17,7 +18,7 @@ shortTitle: Permission user repositories
|
|||
|
||||
Repositories owned by user accounts have one owner. Ownership permissions can't be shared with another user account.
|
||||
|
||||
You can also {% ifversion fpt %}invite{% else %}add{% endif %} users on {% data variables.product.product_name %} to your repository as collaborators. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)."
|
||||
You can also {% ifversion fpt or ghec %}invite{% else %}add{% endif %} users on {% data variables.product.product_name %} to your repository as collaborators. For more information, see "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)."
|
||||
|
||||
{% tip %}
|
||||
|
||||
|
@ -31,26 +32,26 @@ The repository owner has full control of the repository. In addition to the acti
|
|||
|
||||
| Action | More information |
|
||||
| :- | :- |
|
||||
| {% ifversion fpt %}Invite collaborators{% else %}Add collaborators{% endif %} | "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)" |
|
||||
| Change the visibility of the repository | "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)" |{% ifversion fpt %}
|
||||
| Limit interactions with the repository | "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghae-next %}
|
||||
| {% ifversion fpt or ghec %}Invite collaborators{% else %}Add collaborators{% endif %} | "[Inviting collaborators to a personal repository](/github/setting-up-and-managing-your-github-user-account/inviting-collaborators-to-a-personal-repository)" |
|
||||
| Change the visibility of the repository | "[Setting repository visibility](/github/administering-a-repository/setting-repository-visibility)" |{% ifversion fpt or ghec %}
|
||||
| Limit interactions with the repository | "[Limiting interactions in your repository](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghae-next or ghec %}
|
||||
| Rename a branch, including the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %}
|
||||
| Merge a pull request on a protected branch, even if there are no approving reviews | "[About protected branches](/github/administering-a-repository/about-protected-branches)" |
|
||||
| Delete the repository | "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)" |
|
||||
| Manage the repository's topics | "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" |{% ifversion fpt %}
|
||||
| Manage security and analysis settings for the repository | "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" |{% endif %}{% ifversion fpt %}
|
||||
| Enable the dependency graph for a private repository | "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 %}
|
||||
| Manage the repository's topics | "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" |{% ifversion fpt or ghec %}
|
||||
| Manage security and analysis settings for the repository | "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" |{% endif %}{% ifversion fpt or ghec %}
|
||||
| Enable the dependency graph for a private repository | "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)" |{% endif %}{% ifversion fpt or ghes > 3.0 or ghec %}
|
||||
| Delete and restore packages | "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" |{% endif %}{% ifversion ghes = 2.22 or ghes = 3.0 or ghae %}
|
||||
| Delete packages | "[Deleting packages](/packages/learn-github-packages/deleting-a-package)" |{% endif %}
|
||||
| Customize the repository's social media preview | "[Customizing your repository's social media preview](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" |
|
||||
| Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes > 2.22 or ghae-issue-4864 %}
|
||||
| Control access to {% data variables.product.prodname_dependabot_alerts %} alerts for vulnerable dependencies | "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt %}
|
||||
| Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% ifversion fpt or ghes > 2.22 or ghae-issue-4864 or ghec %}
|
||||
| Control access to {% data variables.product.prodname_dependabot_alerts %} alerts for vulnerable dependencies | "[Managing security and analysis settings for your repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)" |{% endif %}{% ifversion fpt or ghec %}
|
||||
| Dismiss {% data variables.product.prodname_dependabot_alerts %} in the repository | "[Viewing and updating vulnerable dependencies in your repository](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository)" |
|
||||
| Manage data use for a private repository | "[Managing data use settings for your private repository](/github/understanding-how-github-uses-and-protects-your-data/managing-data-use-settings-for-your-private-repository)"|{% endif %}
|
||||
| Define code owners for the repository | "[About code owners](/github/creating-cloning-and-archiving-repositories/about-code-owners)" |
|
||||
| Archive the repository | "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt %}
|
||||
| Archive the repository | "[Archiving repositories](/repositories/archiving-a-github-repository/archiving-repositories)" |{% ifversion fpt or ghec %}
|
||||
| Create security advisories | "[About {% data variables.product.prodname_security_advisories %}](/github/managing-security-vulnerabilities/about-github-security-advisories)" |
|
||||
| Display a sponsor button | "[Displaying a sponsor button in your repository](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}{% ifversion fpt or ghae or ghes > 3.0 %}
|
||||
| Display a sponsor button | "[Displaying a sponsor button in your repository](/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository)" |{% endif %}{% ifversion fpt or ghae or ghes > 3.0 or ghec %}
|
||||
| Allow or disallow auto-merge for pull requests | "[Managing auto-merge for pull requests in your repository](/github/administering-a-repository/managing-auto-merge-for-pull-requests-in-your-repository)" | {% endif %}
|
||||
|
||||
## Collaborator access for a repository owned by a user account
|
||||
|
@ -67,21 +68,21 @@ Collaborators can also perform the following actions.
|
|||
|
||||
| Action | More information |
|
||||
| :- | :- |
|
||||
| Fork the repository | "[About forks](/github/collaborating-with-issues-and-pull-requests/about-forks)" |{% ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
| Fork the repository | "[About forks](/github/collaborating-with-issues-and-pull-requests/about-forks)" |{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
|
||||
| Rename a branch other than the default branch | "[Renaming a branch](/github/administering-a-repository/renaming-a-branch)" |{% endif %}
|
||||
| Create, edit, and delete comments on commits, pull requests, and issues in the repository | <ul><li>"[About issues](/github/managing-your-work-on-github/about-issues)"</li><li>"[Commenting on a pull request](/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request)"</li><li>"[Managing disruptive comments](/communities/moderating-comments-and-conversations/managing-disruptive-comments)"</li></ul> |
|
||||
| Create, assign, close, and re-open issues in the repository | "[Managing your work with issues](/github/managing-your-work-on-github/managing-your-work-with-issues)" |
|
||||
| Manage labels for issues and pull requests in the repository | "[Labeling issues and pull requests](/github/managing-your-work-on-github/labeling-issues-and-pull-requests)" |
|
||||
| Manage milestones for issues and pull requests in the repository | "[Creating and editing milestones for issues and pull requests](/github/managing-your-work-on-github/creating-and-editing-milestones-for-issues-and-pull-requests)" |
|
||||
| Mark an issue or pull request in the repository as a duplicate | "[About duplicate issues and pull requests](/github/managing-your-work-on-github/about-duplicate-issues-and-pull-requests)" |
|
||||
| Create, merge, and close pull requests in the repository | "[Proposing changes to your work with pull requests](/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)" |{% ifversion fpt or ghae or ghes > 3.0 %}
|
||||
| Create, merge, and close pull requests in the repository | "[Proposing changes to your work with pull requests](/github/collaborating-with-issues-and-pull-requests/proposing-changes-to-your-work-with-pull-requests)" |{% ifversion fpt or ghae or ghes > 3.0 or ghec %}
|
||||
| Enable and disable auto-merge for a pull request | "[Automatically merging a pull request](/github/collaborating-with-issues-and-pull-requests/automatically-merging-a-pull-request)"{% endif %}
|
||||
| Apply suggested changes to pull requests in the repository |"[Incorporating feedback in your pull request](/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request)" |
|
||||
| Create a pull request from a fork of the repository | "[Creating a pull request from a fork](/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request-from-a-fork)" |
|
||||
| Submit a review on a pull request that affects the mergeability of the pull request | "[Reviewing proposed changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request)" |
|
||||
| Create and edit a wiki for the repository | "[About wikis](/communities/documenting-your-project-with-wikis/about-wikis)" |
|
||||
| Create and edit releases for the repository | "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)" |
|
||||
| Act as a code owner for the repository | "[About code owners](/articles/about-code-owners)" |{% ifversion fpt or ghae %}
|
||||
| Act as a code owner for the repository | "[About code owners](/articles/about-code-owners)" |{% ifversion fpt or ghae or ghec %}
|
||||
| Publish, view, or install packages | "[Publishing and managing packages](/github/managing-packages-with-github-packages/publishing-and-managing-packages)" |{% endif %}
|
||||
| Remove themselves as collaborators on the repository | "[Removing yourself from a collaborator's repository](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository)" |
|
||||
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Permission user project boards
|
||||
|
|
|
@ -7,6 +7,7 @@ redirect_from:
|
|||
- /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/what-does-the-available-for-hire-checkbox-do
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Available for hire checkbox
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Organization membership
|
||||
|
@ -37,9 +38,9 @@ For more information, see the <a href="/articles/github-privacy-statement/" clas
|
|||
|
||||
By default, your organization membership visibility is set to private. You can choose to publicize individual organization memberships on your profile. For more information, see "[Publicizing or hiding organization membership](/articles/publicizing-or-hiding-organization-membership)."
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
If your organization belongs to an enterprise account, you are automatically a member of the enterprise account and visible to enterprise account owners. For more information, see "[About enterprise accounts](/articles/about-enterprise-accounts)."
|
||||
If your organization belongs to an enterprise account, you are automatically a member of the enterprise account and visible to enterprise account owners. For more information, see "[About enterprise accounts](/admin/overview/about-enterprise-accounts)."
|
||||
|
||||
{% endif %}
|
||||
|
||||
|
|
|
@ -12,6 +12,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
---
|
||||
|
|
|
@ -8,6 +8,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
children:
|
||||
|
|
|
@ -3,6 +3,7 @@ title: Managing your scheduled reminders
|
|||
intro: Get reminders in Slack when you or your team have pull requests waiting for review.
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
redirect_from:
|
||||
|
|
|
@ -10,6 +10,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Show or hide membership
|
||||
|
|
|
@ -10,11 +10,12 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Leave an organization
|
||||
---
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
{% warning %}
|
||||
|
||||
|
|
|
@ -9,6 +9,7 @@ redirect_from:
|
|||
- /github/setting-up-and-managing-your-github-user-account/managing-your-membership-in-organizations/requesting-organization-approval-for-oauth-apps
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: Request OAuth App approval
|
||||
|
|
|
@ -10,6 +10,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- Accounts
|
||||
shortTitle: View people in an organization
|
||||
|
|
|
@ -10,6 +10,7 @@ redirect_from:
|
|||
- /actions/guides/caching-dependencies-to-speed-up-workflows
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- Workflows
|
||||
|
|
|
@ -6,6 +6,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/guides/caching-and-storing-workflow-data
|
||||
children:
|
||||
|
|
|
@ -13,6 +13,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- Workflows
|
||||
|
@ -35,7 +36,7 @@ These are some of the common artifacts that you can upload:
|
|||
- Binary or compressed files
|
||||
- Stress test performance output and code coverage results
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
Storing artifacts uses storage space on {% data variables.product.product_name %}. {% data reusables.github-actions.actions-billing %} For more information, see "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)."
|
||||
|
||||
|
@ -47,7 +48,7 @@ Artifacts consume storage space on the external blob storage that is configured
|
|||
|
||||
Artifacts are uploaded during a workflow run, and you can view an artifact's name and size in the UI. When an artifact is downloaded using the {% data variables.product.product_name %} UI, all files that were individually uploaded as part of the artifact get zipped together into a single file. This means that billing is calculated based on the size of the uploaded artifact and not the size of the zip file.
|
||||
|
||||
{% data variables.product.product_name %} provides two actions that you can use to upload and download build artifacts. For more information, see the {% ifversion fpt %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) actions{% else %} `actions/upload-artifact` and `download-artifact` actions on {% data variables.product.product_location %}{% endif %}.
|
||||
{% data variables.product.product_name %} provides two actions that you can use to upload and download build artifacts. For more information, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) actions{% else %} `actions/upload-artifact` and `download-artifact` actions on {% data variables.product.product_location %}{% endif %}.
|
||||
|
||||
To share data between jobs:
|
||||
|
||||
|
@ -62,7 +63,7 @@ You can create a continuous integration (CI) workflow to build and test your cod
|
|||
|
||||
The output of building and testing your code often produces files you can use to debug test failures and production code that you can deploy. You can configure a workflow to build and test the code pushed to your repository and report a success or failure status. You can upload the build and test output to use for deployments, debugging failed tests or crashes, and viewing test suite coverage.
|
||||
|
||||
You can use the `upload-artifact` action to upload artifacts. When uploading an artifact, you can specify a single file or directory, or multiple files or directories. You can also exclude certain files or directories, and use wildcard patterns. We recommend that you provide a name for an artifact, but if no name is provided then `artifact` will be used as the default name. For more information on syntax, see the {% ifversion fpt %}[actions/upload-artifact](https://github.com/actions/upload-artifact) action{% else %} `actions/upload-artifact` action on {% data variables.product.product_location %}{% endif %}.
|
||||
You can use the `upload-artifact` action to upload artifacts. When uploading an artifact, you can specify a single file or directory, or multiple files or directories. You can also exclude certain files or directories, and use wildcard patterns. We recommend that you provide a name for an artifact, but if no name is provided then `artifact` will be used as the default name. For more information on syntax, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) action{% else %} `actions/upload-artifact` action on {% data variables.product.product_location %}{% endif %}.
|
||||
|
||||
### Example
|
||||
|
||||
|
@ -114,7 +115,7 @@ jobs:
|
|||
path: output/test/code-coverage.html
|
||||
```
|
||||
|
||||
{% ifversion fpt or ghes > 2.22 or ghae %}
|
||||
{% ifversion fpt or ghes > 2.22 or ghae or ghec %}
|
||||
## Configuring a custom artifact retention period
|
||||
|
||||
You can define a custom retention period for individual artifacts created by a workflow. When using a workflow to create a new artifact, you can use `retention-days` with the `upload-artifact` action. This example demonstrates how to set a custom retention period of 5 days for the artifact named `my-artifact`:
|
||||
|
@ -165,11 +166,11 @@ You can also download all artifacts in a workflow run by not specifying a name.
|
|||
|
||||
If you download all a workflow run's artifacts, a directory for each artifact is created using its name.
|
||||
|
||||
For more information on syntax, see the {% ifversion fpt %}[actions/download-artifact](https://github.com/actions/download-artifact) action{% else %} `actions/download-artifact` action on {% data variables.product.product_location %}{% endif %}.
|
||||
For more information on syntax, see the {% ifversion fpt or ghec %}[actions/download-artifact](https://github.com/actions/download-artifact) action{% else %} `actions/download-artifact` action on {% data variables.product.product_location %}{% endif %}.
|
||||
|
||||
## Passing data between jobs in a workflow
|
||||
|
||||
You can use the `upload-artifact` and `download-artifact` actions to share data between jobs in a workflow. This example workflow illustrates how to pass data between jobs in the same workflow. For more information, see the {% ifversion fpt %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) actions{% else %} `actions/upload-artifact` and `download-artifact` actions on {% data variables.product.product_location %}{% endif %}.
|
||||
You can use the `upload-artifact` and `download-artifact` actions to share data between jobs in a workflow. This example workflow illustrates how to pass data between jobs in the same workflow. For more information, see the {% ifversion fpt or ghec %}[actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) actions{% else %} `actions/upload-artifact` and `download-artifact` actions on {% data variables.product.product_location %}{% endif %}.
|
||||
|
||||
Jobs that are dependent on a previous job's artifacts must wait for the dependent job to complete successfully. This workflow uses the `needs` keyword to ensure that `job_1`, `job_2`, and `job_3` run sequentially. For example, `job_2` requires `job_1` using the `needs: job_1` syntax.
|
||||
|
||||
|
@ -243,13 +244,13 @@ jobs:
|
|||
```
|
||||
|
||||
The workflow run will archive any artifacts that it generated. For more information on downloading archived artifacts, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)."
|
||||
{% ifversion fpt or ghes > 3.0 or ghae %}
|
||||
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
|
||||
![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png)
|
||||
{% else %}
|
||||
![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow.png)
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
## Further reading
|
||||
|
||||
|
|
|
@ -8,6 +8,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '>=2.22'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
topics:
|
||||
- CLI
|
||||
- Workflows
|
||||
|
|
|
@ -12,6 +12,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- CI
|
||||
|
@ -36,7 +37,7 @@ Building and testing your code requires a server. You can build and test updates
|
|||
{% else %} CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)" and "[About self-hosted runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)."
|
||||
{% endif %}
|
||||
|
||||
You can configure your CI workflow to run when a {% data variables.product.product_name %} event occurs (for example, when new code is pushed to your repository), on a set schedule, or when an external event occurs using the repository dispatch webhook.
|
||||
You can configure your CI workflow to run when a {% data variables.product.prodname_dotcom %} event occurs (for example, when new code is pushed to your repository), on a set schedule, or when an external event occurs using the repository dispatch webhook.
|
||||
|
||||
{% data variables.product.product_name %} runs your CI tests and provides the results of each test in the pull request, so you can see whether the change in your branch introduces an error. When all CI tests in a workflow pass, the changes you pushed are ready to be reviewed by a team member or merged. When a test fails, one of your changes may have caused the failure.
|
||||
|
||||
|
@ -52,10 +53,10 @@ For a definition of common terms, see "[Core concepts for {% data variables.prod
|
|||
|
||||
{% data variables.product.product_name %} offers CI workflow templates for a variety of languages and frameworks.
|
||||
|
||||
Browse the complete list of CI workflow templates offered by {% data variables.product.product_name %} in the {% ifversion fpt %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}.
|
||||
Browse the complete list of CI workflow templates 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.product.product_location %}{% endif %}.
|
||||
|
||||
## Further reading
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)"
|
||||
{% endif %}
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- CI
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- CI
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- CI
|
||||
|
|
|
@ -8,6 +8,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
shortTitle: Build & test .NET
|
||||
---
|
||||
|
||||
|
@ -129,7 +130,7 @@ steps:
|
|||
```
|
||||
{% endraw %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
|
||||
### Caching dependencies
|
||||
|
||||
|
@ -239,7 +240,7 @@ on:
|
|||
|
||||
jobs:
|
||||
deploy:
|
||||
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
|
||||
permissions:
|
||||
packages: write
|
||||
contents: read{% endif %}
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '>=2.22'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- CI
|
||||
|
|
|
@ -10,6 +10,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
hidden: true
|
||||
topics:
|
||||
|
|
|
@ -8,6 +8,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
authors:
|
||||
- potatoqualitee
|
||||
type: tutorial
|
||||
|
@ -73,7 +74,7 @@ jobs:
|
|||
* `run: Test-Path resultsfile.log` - Check whether a file called `resultsfile.log` is present in the repository's root directory.
|
||||
* `Should -Be $true` - Uses Pester to define an expected result. If the result is unexpected, then {% data variables.product.prodname_actions %} flags this as a failed test. For example:
|
||||
|
||||
{% ifversion fpt or ghes > 3.0 or ghae %}
|
||||
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
|
||||
![Failed Pester test](/assets/images/help/repository/actions-failed-pester-test-updated.png)
|
||||
{% else %}
|
||||
![Failed Pester test](/assets/images/help/repository/actions-failed-pester-test.png)
|
||||
|
|
|
@ -10,6 +10,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
hidden: true
|
||||
topics:
|
||||
|
|
|
@ -8,6 +8,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- CI
|
||||
|
@ -284,7 +285,7 @@ on:
|
|||
jobs:
|
||||
build:
|
||||
name: Build + Publish
|
||||
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next %}
|
||||
runs-on: ubuntu-latest{% ifversion fpt or ghes > 3.1 or ghae-next or ghec %}
|
||||
permissions:
|
||||
packages: write
|
||||
contents: read{% endif %}
|
||||
|
|
|
@ -8,6 +8,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- CI
|
||||
|
|
|
@ -8,6 +8,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- CI
|
||||
|
|
|
@ -6,6 +6,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
redirect_from:
|
||||
- /actions/building-and-testing-code-with-continuous-integration
|
||||
- /actions/language-and-framework-guides
|
||||
|
|
|
@ -12,6 +12,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- Action development
|
||||
|
@ -26,7 +27,7 @@ topics:
|
|||
|
||||
You can create actions by writing custom code that interacts with your repository in any way you'd like, including integrating with {% data variables.product.prodname_dotcom %}'s APIs and any publicly available third-party API. For example, an action can publish npm modules, send SMS alerts when urgent issues are created, or deploy production-ready code.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
You can write your own actions to use in your workflow or share the actions you build with the {% data variables.product.prodname_dotcom %} community. To share actions you've built, your repository must be public.
|
||||
{% endif %}
|
||||
|
||||
|
@ -66,15 +67,15 @@ A _composite_ action allows you to combine multiple workflow steps within one ac
|
|||
|
||||
If you're developing an action for other people to use, we recommend keeping the action in its own repository instead of bundling it with other application code. This allows you to version, track, and release the action just like any other software.
|
||||
|
||||
{% ifversion fpt %}
|
||||
{% ifversion fpt or ghec %}
|
||||
Storing an action in its own repository makes it easier for the {% data variables.product.prodname_dotcom %} community to discover the action, narrows the scope of the code base for developers fixing issues and extending the action, and decouples the action's versioning from the versioning of other application code.
|
||||
{% endif %}
|
||||
|
||||
{% ifversion fpt %}If you're building an action that you don't plan to make available to the public, you {% else %} You{% endif %} can store the action's files in any location in your repository. If you plan to combine action, workflow, and application code in a single repository, we recommend storing actions in the `.github` directory. For example, `.github/actions/action-a` and `.github/actions/action-b`.
|
||||
{% ifversion fpt or ghec %}If you're building an action that you don't plan to make available to the public, you {% else %} You{% endif %} can store the action's files in any location in your repository. If you plan to combine action, workflow, and application code in a single repository, we recommend storing actions in the `.github` directory. For example, `.github/actions/action-a` and `.github/actions/action-b`.
|
||||
|
||||
## Compatibility with {% data variables.product.prodname_ghe_server %}
|
||||
|
||||
To ensure that your action is compatible with {% data variables.product.prodname_ghe_server %}, you should make sure that you do not use any hard-coded references to {% data variables.product.prodname_dotcom %} API URLs. You should instead use environment variables to refer to the {% data variables.product.prodname_dotcom %} API:
|
||||
To ensure that your action is compatible with {% data variables.product.prodname_ghe_server %}, you should make sure that you do not use any hard-coded references to {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API URLs. You should instead use environment variables to refer to the {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API:
|
||||
|
||||
- For the REST API, use the `GITHUB_API_URL` environment variable.
|
||||
- For GraphQL, use the `GITHUB_GRAPHQL_URL` environment variable.
|
||||
|
@ -128,7 +129,7 @@ steps:
|
|||
|
||||
### Using a commit's SHA for release management
|
||||
|
||||
Each Git commit receives a calculated SHA value, which is unique and immutable. Your action's users might prefer to rely on a commit's SHA value, as this approach can be more reliable than specifying a tag, which could be deleted or moved. However, this means that users will not receive further updates made to the action. {% ifversion fpt or ghes > 3.0 or ghae %}You must use a commit's full SHA value, and not an abbreviated value.{% else %}Using a commit's full SHA value instead of the abbreviated value can help prevent people from using a malicious commit that uses the same abbreviation.{% endif %}
|
||||
Each Git commit receives a calculated SHA value, which is unique and immutable. Your action's users might prefer to rely on a commit's SHA value, as this approach can be more reliable than specifying a tag, which could be deleted or moved. However, this means that users will not receive further updates made to the action. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}You must use a commit's full SHA value, and not an abbreviated value.{% else %}Using a commit's full SHA value instead of the abbreviated value can help prevent people from using a malicious commit that uses the same abbreviation.{% endif %}
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
|
|
|
@ -8,6 +8,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- Action development
|
||||
|
@ -28,7 +29,7 @@ Once you complete this project, you should understand how to build your own comp
|
|||
|
||||
## Prerequisites
|
||||
|
||||
Before you begin, you'll create a {% data variables.product.product_name %} repository.
|
||||
Before you begin, you'll create a repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %}.
|
||||
|
||||
1. Create a new public repository on {% data variables.product.product_location %}. You can choose any repository name, or use the following `hello-world-composite-action` example. You can add these files after your project has been pushed to {% data variables.product.product_name %}. For more information, see "[Create a new repository](/articles/creating-a-new-repository)."
|
||||
|
||||
|
|
|
@ -11,6 +11,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- Action development
|
||||
|
@ -186,7 +187,7 @@ Now you're ready to test your action out in a workflow. When an action is in a p
|
|||
|
||||
### Example using a public action
|
||||
|
||||
The following workflow code uses the completed _hello world_ action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. {% ifversion fpt %}Public actions can be used even if they're not published to {% data variables.product.prodname_marketplace %}. For more information, see "[Publishing an action](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action)." {% endif %}
|
||||
The following workflow code uses the completed _hello world_ action in the public [`actions/hello-world-docker-action`](https://github.com/actions/hello-world-docker-action) repository. Copy the following workflow example code into a `.github/workflows/main.yml` file, but replace the `actions/hello-world-docker-action` with your repository and action name. You can also replace the `who-to-greet` input with your name. {% ifversion fpt or ghec %}Public actions can be used even if they're not published to {% data variables.product.prodname_marketplace %}. For more information, see "[Publishing an action](/actions/creating-actions/publishing-actions-in-github-marketplace#publishing-an-action)." {% endif %}
|
||||
|
||||
{% raw %}
|
||||
**.github/workflows/main.yml**
|
||||
|
@ -211,7 +212,7 @@ jobs:
|
|||
|
||||
### Example using a private action
|
||||
|
||||
Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. {% ifversion fpt %}This private action can't be published to {% data variables.product.prodname_marketplace %}, and can only be used in this repository.{% endif %}
|
||||
Copy the following example workflow code into a `.github/workflows/main.yml` file in your action's repository. You can also replace the `who-to-greet` input with your name. {% ifversion fpt or ghec %}This private action can't be published to {% data variables.product.prodname_marketplace %}, and can only be used in this repository.{% endif %}
|
||||
|
||||
{% raw %}
|
||||
**.github/workflows/main.yml**
|
||||
|
@ -238,9 +239,9 @@ jobs:
|
|||
```
|
||||
{% endraw %}
|
||||
|
||||
From your repository, click the **Actions** tab, and select the latest workflow run. {% ifversion fpt or ghes > 3.0 or ghae %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
|
||||
From your repository, click the **Actions** tab, and select the latest workflow run. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
|
||||
|
||||
{% ifversion fpt or ghes > 3.0 or ghae %}
|
||||
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
|
||||
![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run-updated.png)
|
||||
{% else %}
|
||||
![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run.png)
|
||||
|
|
|
@ -11,6 +11,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- Action development
|
||||
|
@ -271,9 +272,9 @@ jobs:
|
|||
```
|
||||
{% endraw %}
|
||||
|
||||
From your repository, click the **Actions** tab, and select the latest workflow run. {% ifversion fpt or ghes > 3.0 or ghae %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
|
||||
From your repository, click the **Actions** tab, and select the latest workflow run. {% ifversion fpt or ghes > 3.0 or ghae or ghec %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log.
|
||||
|
||||
{% ifversion fpt or ghes > 3.0 or ghae %}
|
||||
{% ifversion fpt or ghes > 3.0 or ghae or ghec %}
|
||||
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png)
|
||||
{% elsif ghes > 2.22 %}
|
||||
![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated.png)
|
||||
|
|
|
@ -6,6 +6,7 @@ product: '{% data reusables.gated-features.actions %}'
|
|||
redirect_from: []
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
type: tutorial
|
||||
topics:
|
||||
- Actions
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: reference
|
||||
---
|
||||
|
||||
|
|
|
@ -11,6 +11,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
children:
|
||||
- /about-custom-actions
|
||||
- /creating-a-docker-container-action
|
||||
|
|
|
@ -12,6 +12,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: reference
|
||||
---
|
||||
|
||||
|
@ -215,7 +216,7 @@ For example, this `cleanup.js` will only run on Linux-based runners:
|
|||
|
||||
### `runs.steps`
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 %}
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %}
|
||||
**Required** The steps that you plan to run in this action. These can be either `run` steps or `uses` steps.
|
||||
{% else %}
|
||||
**Required** The steps that you plan to run in this action.
|
||||
|
@ -223,7 +224,7 @@ For example, this `cleanup.js` will only run on Linux-based runners:
|
|||
|
||||
#### `runs.steps[*].run`
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 %}
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %}
|
||||
**Optional** The command you want to run. This can be inline or a script in your action repository:
|
||||
{% else %}
|
||||
**Required** The command you want to run. This can be inline or a script in your action repository:
|
||||
|
@ -253,7 +254,7 @@ For more information, see "[`github context`](/actions/reference/context-and-exp
|
|||
|
||||
#### `runs.steps[*].shell`
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 %}
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %}
|
||||
**Optional** The shell where you want to run the command. You can use any of the shells listed [here](/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell). Required if `run` is set.
|
||||
{% else %}
|
||||
**Required** The shell where you want to run the command. You can use any of the shells listed [here](/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell). Required if `run` is set.
|
||||
|
@ -269,13 +270,13 @@ For more information, see "[`github context`](/actions/reference/context-and-exp
|
|||
|
||||
#### `runs.steps[*].env`
|
||||
|
||||
**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% ifversion fpt or ghes > 2.22 or ghae %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite step.
|
||||
**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% ifversion fpt or ghes > 2.22 or ghae or ghec %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite step.
|
||||
|
||||
#### `runs.steps[*].working-directory`
|
||||
|
||||
**Optional** Specifies the working directory where the command is run.
|
||||
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 %}
|
||||
{% ifversion fpt or ghes > 3.2 or ghae-issue-4853 or ghec %}
|
||||
#### `runs.steps[*].uses`
|
||||
|
||||
**Optional** Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a [published Docker container image](https://hub.docker.com/).
|
||||
|
|
|
@ -8,6 +8,7 @@ redirect_from:
|
|||
- /actions/building-actions/publishing-actions-in-github-marketplace
|
||||
versions:
|
||||
fpt: '*'
|
||||
ghec: '*'
|
||||
type: how_to
|
||||
shortTitle: Publish in GitHub Marketplace
|
||||
---
|
||||
|
|
|
@ -9,6 +9,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: how_to
|
||||
---
|
||||
|
||||
|
|
|
@ -6,6 +6,7 @@ versions:
|
|||
fpt: '*'
|
||||
ghes: '*'
|
||||
ghae: '*'
|
||||
ghec: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- CD
|
||||
|
@ -28,19 +29,19 @@ You can set up a {% data variables.product.prodname_actions %} workflow to deplo
|
|||
|
||||
You can configure your CD workflow to run when a {% data variables.product.product_name %} event occurs (for example, when new code is pushed to the default branch of your repository), on a set schedule, manually, or when an external event occurs using the repository dispatch webhook. For more information about when your workflow can run, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows)."
|
||||
|
||||
{% ifversion fpt or ghae or ghes > 3.0 %}
|
||||
{% data variables.product.prodname_actions %} provides features that give you more control over deployments. For example, you can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow, or limit access to secrets. {% ifversion fpt or ghae-next or ghes > 3.1 %}You can use concurrency to limit your CD pipeline to a maximum of one in-progress deployment and one pending deployment. {% endif %}For more information about these features, see "[Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions)" and "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."{% endif %}
|
||||
{% ifversion fpt or ghae or ghes > 3.0 or ghec %}
|
||||
{% data variables.product.prodname_actions %} provides features that give you more control over deployments. For example, you can use environments to require approval for a job to proceed, restrict which branches can trigger a workflow, or limit access to secrets. {% ifversion fpt or ghae-next or ghes > 3.1 or ghec %}You can use concurrency to limit your CD pipeline to a maximum of one in-progress deployment and one pending deployment. {% endif %}For more information about these features, see "[Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions)" and "[Using environments for deployment](/actions/deployment/using-environments-for-deployment)."{% endif %}
|
||||
|
||||
## Workflow templates and third party actions
|
||||
|
||||
{% data reusables.actions.cd-templates-actions %}
|
||||
|
||||
{% ifversion fpt or ghae or ghes > 3.0 %}
|
||||
{% ifversion fpt or ghae or ghes > 3.0 or ghec %}
|
||||
|
||||
## Further reading
|
||||
|
||||
- [Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions)
|
||||
- [Using environments for deployment](/actions/deployment/using-environments-for-deployment){% ifversion fpt %}
|
||||
- [Using environments for deployment](/actions/deployment/using-environments-for-deployment){% ifversion fpt or ghec %}
|
||||
- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)"{% endif %}
|
||||
|
||||
{% endif %}
|
||||
|
|