Skip to content

Commit fd4ad9f

Browse files
committed
merge from main
1 parent 632d4eb commit fd4ad9f

File tree

141 files changed

+853
-582
lines changed

Some content is hidden

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

141 files changed

+853
-582
lines changed

.github/dependabot.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ updates:
99
- package-ecosystem: 'github-actions'
1010
directory: '/'
1111
schedule:
12-
interval: weekly
12+
interval: monthly

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approacha
66

77
In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
88

9-
Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of the this document to get to a specific section of this guide quickly.
9+
Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
1010

1111
## New contributor guide
1212

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This repository contains the documentation website code and Markdown source file
44

55
GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.
66

7-
Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of the this document to get to a specific section of this guide quickly.
7+
Use the table of contents icon <img src="./assets/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
88

99
## Contributing
1010

@@ -60,4 +60,4 @@ When using the GitHub logos, be sure to follow the [GitHub logo guidelines](http
6060

6161
## Thanks :purple_heart:
6262

63-
Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our community !
63+
Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our :sparkles: community :sparkles: !
Loading
Loading
Loading

content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,8 @@ Email notifications from {% data variables.product.product_name %} contain the f
134134
| --- | --- |
135135
| `From` address | This address will always be {% ifversion fpt %}'`notifications@github.com`'{% else %}'the no-reply email address configured by your site administrator'{% endif %}. |
136136
| `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 %} |
137-
| `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 not ghae %}<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> |
138-
| `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 %}
137+
| `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> |
138+
| `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 %}
139139
| `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 %}
140140

141141
## Choosing your notification settings
@@ -144,7 +144,7 @@ Email notifications from {% data variables.product.product_name %} contain the f
144144
{% data reusables.notifications-v2.manage-notifications %}
145145
3. On the notifications settings page, choose how you receive notifications when:
146146
- 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)."
147-
- 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 %}
147+
- 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 %}
148148
- 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 %}
149149
- 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 %}
150150

@@ -161,14 +161,14 @@ If "Automatically watch repositories" is disabled, then you will not automatical
161161
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.
162162

163163
{% data reusables.repositories.navigate-to-repo %}
164-
2. In the upper-right corner, click the "Watch" drop-down menu to select a watch option.
165-
{% ifversion fpt or ghes > 3.0 or ghae-next %}
164+
2. In the upper-right corner, select the "Watch" drop-down menu to click a watch option.
165+
{% ifversion fpt or ghes > 3.0 or ghae-issue-4910 %}
166166
![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom.png)
167167

168168
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.
169169
{% else %}
170170
![Watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options.png){% endif %}
171-
{% ifversion fpt or ghes > 3.0 or ghae-next %}
171+
{% ifversion fpt or ghes > 3.0 or ghae-issue-4910 %}
172172
![Custom watch options in a drop-down menu for a repository](/assets/images/help/notifications-v2/watch-repository-options-custom2-dotcom.png)
173173
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.
174174
{% endif %}
@@ -198,12 +198,8 @@ If you are a member of more than one organization, you can configure each one to
198198
5. Select one of your verified email addresses, then click **Save**.
199199
![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif)
200200

201-
{% ifversion not ghae %}
202-
{% ifversion fpt or ghes %}
201+
{% ifversion fpt or ghes or ghae-issue-4864 %}
203202
## {% data variables.product.prodname_dependabot_alerts %} notification options
204-
{% else %}
205-
## Security alert notification options
206-
{% endif %}
207203

208204
{% data reusables.notifications.vulnerable-dependency-notification-enable %}
209205
{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %}

content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -114,14 +114,14 @@ To filter notifications for specific activity on {% data variables.product.produ
114114
- `is:gist`
115115
- `is:issue-or-pull-request`
116116
- `is:release`
117-
- `is:repository-invitation`{% ifversion not ghae %}
118-
- `is:repository-vulnerability-alert`
117+
- `is:repository-invitation`{% ifversion fpt or ghes or ghae-issue-4864 %}
118+
- `is:repository-vulnerability-alert`{% endif %}{% ifversion fpt %}
119119
- `is:repository-advisory`{% endif %}
120120
- `is:team-discussion`{% ifversion fpt %}
121121
- `is:discussion`{% endif %}
122122

123-
{% ifversion not ghae %}
124-
For information about reducing noise from 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)."
123+
{% ifversion fpt or ghes or ghae-issue-4864 %}
124+
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)."
125125
{% endif %}
126126

127127
You can also use the `is:` query to describe how the notification was triaged.
@@ -144,7 +144,7 @@ To filter notifications by why you've received an update, you can use the `reaso
144144
| `reason:invitation` | When you're invited to a team, organization, or repository.
145145
| `reason:manual` | When you click **Subscribe** on an issue or pull request you weren't already subscribed to.
146146
| `reason:mention` | You were directly @mentioned.
147-
| `reason:review-requested` | You or a team you're on have been requested to review a pull request.{% ifversion not ghae %}
147+
| `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 %}
148148
| `reason:security-alert` | When a security alert is issued for a repository.{% endif %}
149149
| `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.
150150
| `reason:team-mention` | When a team you're a member of is @mentioned.
@@ -163,7 +163,7 @@ For example, to see notifications from the octo-org organization, use `org:octo-
163163

164164
{% endif %}
165165

166-
{% ifversion fpt or ghes %}
166+
{% ifversion fpt or ghes or ghae-issue-4864 %}
167167
## {% data variables.product.prodname_dependabot %} custom filters
168168

169169
{% ifversion fpt %}
@@ -175,8 +175,11 @@ If you use {% data variables.product.prodname_dependabot %} to keep your depende
175175
For more information about {% data variables.product.prodname_dependabot %}, see "[About managing vulnerable dependencies](/github/managing-security-vulnerabilities/about-managing-vulnerable-dependencies)."
176176
{% endif %}
177177

178-
{% ifversion ghes %}
179-
If you use {% data variables.product.prodname_dependabot %} to keep your dependencies-up-to-date, you can use and save the `is:repository_vulnerability_alert` custom filter to show notifications for {% data variables.product.prodname_dependabot_alerts %}.
178+
{% ifversion ghes or ghae-issue-4864 %}
179+
180+
If you use {% data variables.product.prodname_dependabot %} to keep your dependencies-up-to-date, you can use and save these custom filters to show notifications for {% data variables.product.prodname_dependabot_alerts %}:
181+
- `is:repository_vulnerability_alert`
182+
- `reason:security_alert`
180183

181184
For more information about {% data variables.product.prodname_dependabot %}, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)."
182185
{% endif %}

content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ topics:
1414
- Profiles
1515
shortTitle: Organization's profile
1616
---
17-
You can optionally choose to add a description, location, website, and email address for your organization, and pin important repositories. 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)."
17+
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 %}
1818

1919
{% 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 %}
2020

content/actions/deployment/about-continuous-deployment.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,12 @@ You can configure your CD workflow to run when a {% data variables.product.produ
3434

3535
{% data reusables.actions.cd-templates-actions %}
3636

37+
{% ifversion fpt or ghae or ghes > 3.0 %}
38+
3739
## Further reading
3840

3941
- [Deploying with GitHub Actions](/actions/deployment/deploying-with-github-actions)
4042
- [Using environments for deployment](/actions/deployment/using-environments-for-deployment){% ifversion fpt %}
41-
- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)"
43+
- "[Managing billing for {% data variables.product.prodname_actions %}](/billing/managing-billing-for-github-actions)"{% endif %}
44+
4245
{% endif %}

content/actions/deployment/deploying-to-amazon-elastic-container-service.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ shortTitle: Deploy to Amazon ECS
2121

2222
## Introduction
2323

24-
This guide explains how to use {% data variables.product.prodname_actions %} to build a containerized application, push it to [Amazon Elastic Container Registry (ECR)](https://aws.amazon.com/ecr/), and deploy it to [Amazon Elastic Container Service (ECS)](https://aws.amazon.com/ecs/) when a release is created.
24+
This guide explains how to use {% data variables.product.prodname_actions %} to build a containerized application, push it to [Amazon Elastic Container Registry (ECR)](https://aws.amazon.com/ecr/), and deploy it to [Amazon Elastic Container Service (ECS)](https://aws.amazon.com/ecs/) when there is a push to the `main` branch.
2525

26-
On every new release in your {% data variables.product.company_short %} repository, the {% data variables.product.prodname_actions %} workflow builds and pushes a new container image to Amazon ECR, and then deploys a new task definition to Amazon ECS.
26+
On every new push to `main` in your {% data variables.product.company_short %} repository, the {% data variables.product.prodname_actions %} workflow builds and pushes a new container image to Amazon ECR, and then deploys a new task definition to Amazon ECS.
2727

2828
## Prerequisites
2929

@@ -67,7 +67,9 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you
6767
6868
See the documentation for each action used below for the recommended IAM policies for the IAM user, and methods for handling the access key credentials.
6969
70+
{% ifversion fpt or ghes > 3.0 or ghae %}
7071
5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
72+
{% endif %}
7173
7274
## Creating the workflow
7375
@@ -85,8 +87,9 @@ Ensure that you provide your own values for all the variables in the `env` key o
8587
name: Deploy to Amazon ECS
8688
8789
on:
88-
release:
89-
types: [ created ]
90+
push:
91+
branches:
92+
- main
9093
9194
env:
9295
AWS_REGION: MY_AWS_REGION # set this to your preferred AWS region, e.g. us-west-1

content/actions/deployment/deploying-to-azure-app-service.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,15 @@ Before creating your {% data variables.product.prodname_actions %} workflow, you
6969

7070
4. For Linux apps, add an app setting called `WEBSITE_WEBDEPLOY_USE_SCM` and set it to true in your app. For more information, see "[Configure apps in the portal](https://docs.microsoft.com/en-us/azure/app-service/configure-common#configure-app-settings)" in the Azure documentation.
7171

72+
{% ifversion fpt or ghes > 3.0 or ghae %}
7273
5. Optionally, configure a deployment environment. {% data reusables.actions.about-environments %}
74+
{% endif %}
7375

7476
## Creating the workflow
7577

7678
Once you've completed the prerequisites, you can proceed with creating the workflow.
7779

78-
The following example workflow demonstrates how to build, test, and deploy the Node.js project to Azure App Service when a release is created.
80+
The following example workflow demonstrates how to build, test, and deploy the Node.js project to Azure App Service when there is a push to the `main` branch.
7981

8082
Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of the web app you created. You can also change `AZURE_WEBAPP_PACKAGE_PATH` if the path to your project is not the repository root and `NODE_VERSION` if you want to use a node version other than `10.x`.
8183

@@ -85,8 +87,9 @@ Ensure that you set `AZURE_WEBAPP_NAME` in the workflow `env` key to the name of
8587
{% data reusables.actions.actions-not-certified-by-github-comment %}
8688
8789
on:
88-
release:
89-
types: [created]
90+
push:
91+
branches:
92+
- main
9093
9194
env:
9295
AZURE_WEBAPP_NAME: MY_WEBAPP_NAME # set this to your application's name

0 commit comments

Comments
 (0)