Skip to content

Commit ca4645e

Browse files
authored
Merge branch 'main' into fix-table-overflow
2 parents e896f48 + eb4beeb commit ca4645e

File tree

994 files changed

+9920
-4497
lines changed

Some content is hidden

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

994 files changed

+9920
-4497
lines changed

.github/workflows/check-all-english-links.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
name: Check all English links
22

33
on:
4+
workflow_dispatch:
45
schedule:
56
- cron: "40 19 * * *" # once a day at 19:40 UTC / 11:40 PST
67

@@ -16,15 +17,15 @@ jobs:
1617
- name: npm run build
1718
run: npm run build
1819
- name: Run script
19-
run: script/check-external-links en > broken_links.md
20+
run: script/check-english-links.js > broken_links.md
2021
- name: Check if any broken links
2122
id: check
2223
run: |
23-
if [ "$(grep 'All links are good' broken_links.md)" ]; then
24+
if [ "$(grep '0 broken links found' broken_links.md)" ]; then
2425
echo ::set-output name=continue::no
2526
else
2627
echo "::set-output name=continue::yes"
27-
echo "::set-output name=title::$(grep 'found on help.github.com' broken_links.md)"
28+
echo "::set-output name=title::$(head -1 broken_links.md)"
2829
fi
2930
- if: ${{ steps.check.outputs.continue == 'yes' }}
3031
name: Create issue from file
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Repo Freeze Check
2+
3+
on:
4+
pull_request:
5+
types:
6+
- opened
7+
- reopened
8+
- synchronize
9+
- ready_for_review
10+
- unlocked
11+
branches:
12+
- main
13+
14+
env:
15+
FREEZE: ${{ secrets.FREEZE }}
16+
17+
jobs:
18+
check-freezer:
19+
name: Prevent merging during deployment freezes
20+
runs-on: ubuntu-latest
21+
steps:
22+
23+
- name: Fail if repo merges are paused
24+
if: ${{ env.FREEZE == 'true' }}
25+
run: |
26+
echo 'Merges into the "main" branch on this repo are currently paused!'
27+
exit 1

.gitignore

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
node_modules
55
npm-debug.log
66
coverage
7-
8-
# blc: broken link checker
9-
blc_output.log
10-
blc_output_internal.log
11-
dist
7+
.linkinator
8+
broken_links.md
9+
dist
Loading
Loading
Loading
Loading
Loading
Loading

content/actions/guides/building-and-testing-powershell.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ product: '{% data reusables.gated-features.actions %}'
55
versions:
66
free-pro-team: '*'
77
enterprise-server: '>=2.22'
8+
authors:
9+
- potatoqualitee
810
---
911

1012
{% data reusables.actions.enterprise-beta %}

content/actions/guides/publishing-nodejs-packages.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ redirect_from:
88
versions:
99
free-pro-team: '*'
1010
enterprise-server: '>=2.22'
11+
authors:
12+
- GitHub
1113
---
1214

1315
{% data reusables.actions.enterprise-beta %}

content/actions/guides/setting-up-continuous-integration-using-workflow-templates.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ redirect_from:
1111
versions:
1212
free-pro-team: '*'
1313
enterprise-server: '>=2.22'
14+
authors:
15+
- GitHub
1416
---
1517

1618
{% data reusables.actions.enterprise-beta %}

content/actions/index.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,23 @@ introLinks:
77
reference: /actions/reference
88
featuredLinks:
99
guides:
10-
- /actions/guides/setting-up-continuous-integration-using-workflow-templates
10+
- /actions/learn-github-actions
11+
- /actions/guides/about-continuous-integration
1112
- /actions/guides/about-packaging-with-github-actions
1213
gettingStarted:
1314
- /actions/managing-workflow-runs
1415
- /actions/hosting-your-own-runners
16+
guideCards:
17+
- /actions/guides/setting-up-continuous-integration-using-workflow-templates
18+
- /actions/guides/publishing-nodejs-packages
19+
- /actions/guides/building-and-testing-powershell
1520
popular:
1621
- /actions/reference/workflow-syntax-for-github-actions
1722
- /actions/reference/events-that-trigger-workflows
23+
- /actions/learn-github-actions
24+
- /actions/reference/context-and-expression-syntax-for-github-actions
25+
- /actions/reference/workflow-commands-for-github-actions
26+
- /actions/reference/environment-variables
1827
changelog:
1928
- title: Self-Hosted Runner Group Access Changes
2029
date: '2020-10-16'
@@ -51,7 +60,7 @@ versions:
5160

5261
<!-- Code examples -->
5362
<div class="my-6 pt-6">
54-
<h2 class="mb-2">More guides</h2>
63+
<h2 class="mb-2 font-mktg h1">Code examples</h2>
5564

5665
<div class="d-flex flex-wrap gutter">
5766
<div class="col-12 col-lg-4 mb-4">
@@ -151,6 +160,4 @@ versions:
151160
</a>
152161
</div>
153162
</div>
154-
155-
<a href="/actions/guides" class="btn btn-outline mt-4">Show all guides {% octicon "arrow-right" %}</a>
156163
</div>

content/actions/quickstart.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,3 +75,69 @@ The super-linter workflow you just added runs any time code is pushed to your re
7575
- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" for an in-depth tutorial
7676
- "[Guides](/actions/guides)" for specific uses cases and examples
7777
- [github/super-linter](https://github.com/github/super-linter) for more details about configuring the Super-Linter action
78+
79+
<div id="quickstart-treatment" hidden>
80+
81+
### Introduction
82+
83+
Printing "Hello, World!" is a great way to explore the basic set up and syntax of a new programming language. In this guide, you'll use GitHub Actions to print "Hello, World!" within your {% data variables.product.prodname_dotcom %} repository's workflow logs. All you need to get started is a {% data variables.product.prodname_dotcom %} repository where you feel comfortable creating and running a sample {% data variables.product.prodname_actions %} workflow. Feel free to create a new repository for this Quickstart, you can use it to test this and future {% data variables.product.prodname_actions %} workflows.
84+
85+
### Creating your first workflow
86+
87+
1. From your repository on {% data variables.product.prodname_dotcom %}, create a new file in the `.github/workflows` directory named `hello-world.yml`. For more information, see "[Creating new files](/github/managing-files-in-a-repository/creating-new-files)."
88+
2. Copy the following YAML contents into the `hello-world.yml` file.
89+
{% raw %}
90+
```yaml{:copy}
91+
name: Say hello!
92+
93+
# GitHub Actions Workflows are automatically triggered by GitHub events
94+
on:
95+
# For this workflow, we're using the workflow_dispatch event which is triggered when the user clicks Run workflow in the GitHub Actions UI
96+
workflow_dispatch:
97+
# The workflow_dispatch event accepts optional inputs so you can customize the behavior of the workflow
98+
inputs:
99+
name:
100+
description: 'Person to greet'
101+
required: true
102+
default: 'World'
103+
# When the event is triggered, GitHub Actions will run the jobs indicated
104+
jobs:
105+
say_hello:
106+
# Uses a ubuntu-lates runner to complete the requested steps
107+
runs-on: ubuntu-latest
108+
steps:
109+
- run: |
110+
echo "Hello ${{ github.event.inputs.name }}!"
111+
```
112+
{% endraw %}
113+
3. Scroll to the bottom of the page and select **Create a new branch for this commit and start a pull request**. Then, to create a pull request, click **Propose new file**.
114+
![Commit workflow file](/assets/images/help/repository/commit-hello-world-file.png)
115+
4. Once the pull request has been merged, you'll be ready to move on to "Trigger your workflow".
116+
117+
### Trigger your workflow
118+
119+
{% data reusables.repositories.navigate-to-repo %}
120+
{% data reusables.repositories.actions-tab %}
121+
1. In the left sidebar, click the workfow you want to run.
122+
![Select say hello job](/assets/images/help/repository/say-hello-job.png)
123+
1. On the right, click the **Run workflow** drop-down and click **Run workflow**. Optionally, you can enter a custom message into the "Person to greet" input before running the workflow.
124+
![Trigger the manual workflow](/assets/images/help/repository/manual-workflow-trigger.png)
125+
1. The workflow run will appear at the top of the list of "Say hello!" workflow runs. Click "Say hello!" to see the result of the workflow run.
126+
![Workflow run result listing](/assets/images/help/repository/workflow-run-listing.png)
127+
1. In the left sidebar, click the "say_hello" job.
128+
![Workflow job listing](/assets/images/help/repository/workflow-job-listing.png)
129+
1. In the workflow logs, expand the 'Run echo "Hello World!"' section.
130+
![Workflow detail](/assets/images/help/repository/workflow-log-listing.png)
131+
132+
### More starter workflows
133+
134+
{% data variables.product.prodname_dotcom %} provides preconfigured workflow templates that you can start from to automate or create a continuous integration workflows. You can browse the full list of workflow templates in the {% if currentVersion == "free-pro-team@latest" %}[actions/starter-workflows](https://github.com/actions/starter-workflows) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.product_location %}{% endif %}.
135+
136+
### Next steps
137+
138+
The hello-world workflow you just added is a simple example of a manually triggered workflow. This is only the beginning of what you can do with {% data variables.product.prodname_actions %}. Your repository can contain multiple workflows that trigger different jobs based on different events. {% data variables.product.prodname_actions %} can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with {% data variables.product.prodname_actions %}:
139+
140+
- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" for an in-depth tutorial
141+
- "[Guides](/actions/guides)" for specific uses cases and examples
142+
143+
</div>

content/actions/reference/specifications-for-github-hosted-runners.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You can specify the runner type for each job in a workflow. Each job in a workfl
3131

3232
{% data variables.product.prodname_dotcom %} hosts Linux and Windows runners on Standard_DS2_v2 virtual machines in Microsoft Azure with the {% data variables.product.prodname_actions %} runner application installed. The {% data variables.product.prodname_dotcom %}-hosted runner application is a fork of the Azure Pipelines Agent. Inbound ICMP packets are blocked for all Azure virtual machines, so ping or traceroute commands might not work. For more information about the Standard_DS2_v2 machine resources, see "[Dv2 and DSv2-series](https://docs.microsoft.com/azure/virtual-machines/dv2-dsv2-series#dsv2-series)" in the Microsoft Azure documentation.
3333

34-
{% data variables.product.prodname_dotcom %} uses [MacStadium](https://www.macstadium.com/) to host the macOS runners.
34+
{% data variables.product.prodname_dotcom %} hosts macOS runners in {% data variables.product.prodname_dotcom %}'s own macOS Cloud.
3535

3636
#### Administrative privileges of {% data variables.product.prodname_dotcom %}-hosted runners
3737

content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,7 @@ To configure authentication and user provisioning for {% data variables.product.
2828

2929
{% if currentVersion == "github-ae@latest" %}
3030

31-
1. In Azure AD, add {% data variables.product.ae_azure_ad_app_link %} to your tenant and configure single sign-on.
32-
33-
| Value in Azure AD | Value from {% data variables.product.prodname_ghe_managed %} |
34-
| :- | :- |
35-
| Identifier (Entity ID) | <code>https://<em>YOUR-GITHUB-AE-HOSTNAME</em><code> |
36-
| Reply URL | <code>https://<em>YOUR-GITHUB-AE-HOSTNAME</em>/saml/consume</code> |
37-
| Sign on URL | <code>https://<em>YOUR-GITHUB-AE-HOSTNAME</em>/sso</code> |
31+
1. In Azure AD, add {% data variables.product.ae_azure_ad_app_link %} to your tenant and configure single sign-on. For more information, see [Tutorial: Azure Active Directory single sign-on (SSO) integration with {% data variables.product.prodname_ghe_managed %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) in the Microsoft Docs.
3832

3933
1. In {% data variables.product.prodname_ghe_managed %}, enter the details for your Azure AD tenant.
4034

content/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,12 @@ After a user successfully authenticates on your IdP, the user's SAML session for
3838

3939
{% data reusables.saml.ae-enable-saml-sso-during-bootstrapping %}
4040

41+
The following IdPs provide documentation about configuring SAML SSO for {% data variables.product.product_name %}. If your IdP isn't listed, please contact your IdP to request support for {% data variables.product.product_name %}.
42+
43+
| IdP | More information |
44+
| :- | :- |
45+
| Azure AD | [Tutorial: Azure Active Directory single sign-on (SSO) integration with {% data variables.product.prodname_ghe_managed %}](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-tutorial) in the Microsoft Docs |
46+
4147
During initialization for {% data variables.product.product_name %}, you must configure {% data variables.product.product_name %} as a SAML Service Provider (SP) on your IdP. You must enter several unique values on your IdP to configure {% data variables.product.product_name %} as a valid SP.
4248

4349
| Value | Other names | Description | Example |

content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,15 @@ You must have administrative access on your IdP to configure the application for
6262
![Checkbox for "Require SCIM user provisioning" within enterprise security settings](/assets/images/help/enterprises/settings-require-scim-user-provisioning.png)
6363
1. Click **Save**.
6464
![Save button under "Require SCIM user provisioning" within enterprise security settings](/assets/images/help/enterprises/settings-scim-save.png)
65-
1. Configure user provisioning in the application for {% data variables.product.product_name %} on your IdP. The application on your IdP requires two values to provision or deprovision user accounts on {% data variables.product.product_location %}.
65+
1. Configure user provisioning in the application for {% data variables.product.product_name %} on your IdP.
66+
67+
The following IdPs provide documentation about configuring provisioning for {% data variables.product.product_name %}. If your IdP isn't listed, please contact your IdP to request support for {% data variables.product.product_name %}.
68+
69+
| IdP | More information |
70+
| :- | :- |
71+
| Azure AD | [Tutorial: Configure {% data variables.product.prodname_ghe_managed %} for automatic user provisioning](https://docs.microsoft.com/azure/active-directory/saas-apps/github-ae-provisioning-tutorial) in the Microsoft Docs |
72+
73+
The application on your IdP requires two values to provision or deprovision user accounts on {% data variables.product.product_location %}.
6674

6775
| Value | Other names | Description | Example |
6876
| :- | :- | :- | :- |

content/github/administering-a-repository/about-secret-scanning.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: About secret scanning
33
intro: '{% data variables.product.product_name %} scans repositories for known types of secrets, to prevent fraudulent use of secrets that were committed accidentally.'
4+
product: '{% data reusables.gated-features.secret-scanning %}'
45
redirect_from:
56
- /github/administering-a-repository/about-token-scanning
67
- /articles/about-token-scanning

content/github/administering-a-repository/configuring-secret-scanning-for-private-repositories.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Configuring secret scanning for private repositories
33
intro: 'You can configure how {% data variables.product.product_name %} scans your private repositories for secrets.'
4+
product: '{% data reusables.gated-features.secret-scanning %}'
45
permissions: 'People with admin permissions to a private repository can enable {% data variables.product.prodname_secret_scanning %} for the repository.'
56
versions:
67
free-pro-team: '*'

content/github/administering-a-repository/managing-alerts-from-secret-scanning.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Managing alerts from secret scanning
33
intro: You can view and close alerts for secrets checked in to your repository.
4+
product: '{% data reusables.gated-features.secret-scanning %}'
45
versions:
56
free-pro-team: '*'
67
---

content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ If the `autobuild` command can't build your code, you can run the build steps yo
9797

9898
By default, the {% data variables.product.prodname_codeql_runner %} uploads results from {% data variables.product.prodname_code_scanning %} when you run the `analyze` command. You can also upload SARIF files separately, by using the `upload` command.
9999

100-
Once you've uploaded the data, {% data variables.product.prodname_dotcom %} displays the alerts in your repository. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-an-alert)."
100+
Once you've uploaded the data, {% data variables.product.prodname_dotcom %} displays the alerts in your repository. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."
101101

102102
### {% data variables.product.prodname_codeql_runner %} command reference
103103

content/github/finding-security-vulnerabilities-and-errors-in-your-code/enabling-code-scanning-for-a-repository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ After enabling {% data variables.product.prodname_code_scanning %} for your repo
6262

6363
1. Review the logging output from the actions in this workflow as they run.
6464

65-
1. Once all jobs are complete, you can view the details of any {% data variables.product.prodname_code_scanning %} alerts that were identified. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-an-alert)."
65+
1. Once all jobs are complete, you can view the details of any {% data variables.product.prodname_code_scanning %} alerts that were identified. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-repository)."
6666

6767
{% note %}
6868

0 commit comments

Comments
 (0)