Skip to content

Commit dea0890

Browse files
authored
Merge branch 'main' into martin389-patch-1
2 parents 6c8e379 + 3d0d13d commit dea0890

64 files changed

Lines changed: 907 additions & 276 deletions

File tree

Some content is hidden

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

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

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@ jobs:
1111
if: github.repository == 'github/docs-internal'
1212
runs-on: ubuntu-latest
1313
steps:
14+
- uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
15+
- name: npm ci
16+
run: npm ci
17+
- name: npm run build
18+
run: npm run build
1419
- name: Run script
1520
run: script/check-english-links.js > broken_links.md
16-
- name: Check if any broken links
21+
- if: ${{ failure() }}
22+
name: Get title for issue
1723
id: check
18-
run: |
19-
if [ "$(grep '0 broken links found' broken_links.md)" ]; then
20-
echo ::set-output name=continue::no
21-
else
22-
echo "::set-output name=continue::yes"
23-
echo "::set-output name=title::$(head -1 broken_links.md)"
24-
fi
25-
- if: ${{ steps.check.outputs.continue == 'yes' }}
24+
run: echo "::set-output name=title::$(head -1 broken_links.md)"
25+
- if: ${{ failure() }}
2626
name: Create issue from file
2727
uses: peter-evans/create-issue-from-file@35e304e2a12caac08c568247a2cb46ecd0c3ecc5
2828
with:
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

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: 31 additions & 107 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ featuredLinks:
1313
gettingStarted:
1414
- /actions/managing-workflow-runs
1515
- /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
1620
popular:
1721
- /actions/reference/workflow-syntax-for-github-actions
1822
- /actions/reference/events-that-trigger-workflows
@@ -21,18 +25,19 @@ featuredLinks:
2125
- /actions/reference/workflow-commands-for-github-actions
2226
- /actions/reference/environment-variables
2327
changelog:
28+
- title: Removing set-env and add-path commands on November 16
29+
date: '2020-11-09'
30+
href: https://github.blog/changelog/2020-10-01-github-actions-deprecating-set-env-and-add-path-commands/
31+
- title: Ubuntu-latest workflows will use Ubuntu-20.04
32+
date: '2020-10-29'
33+
href: https://github.blog/changelog/2020-10-29-github-actions-ubuntu-latest-workflows-will-use-ubuntu-20-04
34+
- title: MacOS Big Sur Preview
35+
date: '2020-10-29'
36+
href: https://github.blog/changelog/2020-10-29-github-actions-macos-big-sur-preview
2437
- title: Self-Hosted Runner Group Access Changes
2538
date: '2020-10-16'
2639
href: https://github.blog/changelog/2020-10-16-github-actions-self-hosted-runner-group-access-changes/
27-
- title: Ability to change retention days for artifacts and logs
28-
date: '2020-10-08'
29-
href: https://github.blog/changelog/2020-10-08-github-actions-ability-to-change-retention-days-for-artifacts-and-logs
30-
- title: Deprecating set-env and add-path commands
31-
date: '2020-10-01'
32-
href: https://github.blog/changelog/2020-10-01-github-actions-deprecating-set-env-and-add-path-commands
33-
- title: Fine-tune access to external actions
34-
date: '2020-10-01'
35-
href: https://github.blog/changelog/2020-10-01-github-actions-fine-tune-access-to-external-actions
40+
3641
redirect_from:
3742
- /articles/automating-your-workflow-with-github-actions/
3843
- /articles/customizing-your-project-with-github-actions/
@@ -55,107 +60,26 @@ versions:
5560
<!-- {% link_with_intro /reference %} -->
5661

5762
<!-- Code examples -->
63+
{% assign actionsCodeExamples = site.data.variables.action_code_examples %}
64+
{% if actionsCodeExamples %}
5865
<div class="my-6 pt-6">
59-
<h2 class="mb-2">More guides</h2>
66+
<h2 class="mb-2 font-mktg h1">Code examples</h2>
67+
68+
<div class="pr-lg-3 mb-5 mt-3">
69+
<input class="js-code-example-filter input-lg py-2 px-3 col-12 col-lg-8 form-control" placeholder="Search code examples" type="text" autocomplete="off" />
70+
</div>
6071

6172
<div class="d-flex flex-wrap gutter">
62-
<div class="col-12 col-lg-4 mb-4">
63-
<a class="Box d-block hover-grow no-underline text-gray-dark" href="/actions/guides/building-and-testing-nodejs">
64-
<div class="p-4">
65-
<h4>Building and testing Node.js</h4>
66-
<p class="mt-2 mb-4">Use GitHub Actions to power CI in your Node.js application.</p>
67-
<div class="d-flex">
68-
<span class="IssueLabel text-white bg-blue mr-2">JavaScript/TypeScript</span>
69-
<span class="IssueLabel text-white bg-blue mr-2">CI</span>
70-
</div>
71-
</div>
72-
<footer class="border-top p-4 text-gray d-flex flex-items-center">
73-
{% octicon "workflow" class="flex-shrink-0" %}
74-
<span class="ml-2">/guides/building-and-testing-nodejs</span>
75-
</footer>
76-
</a>
77-
</div>
78-
<div class="col-12 col-lg-4 mb-4">
79-
<a class="Box d-block hover-grow no-underline text-gray-dark" href="/actions/guides/building-and-testing-python">
80-
<div class="p-4">
81-
<h4>Building and testing Python</h4>
82-
<p class="mt-2 mb-4">Use GitHub Actions to power CI in your Python application.</p>
83-
<div class="d-flex">
84-
<span class="IssueLabel text-white bg-blue mr-2">Python</span>
85-
<span class="IssueLabel text-white bg-blue mr-2">CI</span>
86-
</div>
87-
</div>
88-
<footer class="border-top p-4 text-gray d-flex flex-items-center">
89-
{% octicon "workflow" class="flex-shrink-0" %}
90-
<span class="ml-2">/guides/building-and-testing-python</span>
91-
</footer>
92-
</a>
93-
</div>
94-
<div class="col-12 col-lg-4 mb-4">
95-
<a class="Box d-block hover-grow no-underline text-gray-dark" href="/actions/guides/building-and-testing-java-with-maven">
96-
<div class="p-4">
97-
<h4>Building and testing Java with Maven</h4>
98-
<p class="mt-2 mb-4">Use GitHub Actions to power CI in your Java project with Maven.</p>
99-
<div class="d-flex">
100-
<span class="IssueLabel text-white bg-blue mr-2">Java</span>
101-
<span class="IssueLabel text-white bg-blue mr-2">CI</span>
102-
</div>
103-
</div>
104-
<footer class="border-top p-4 text-gray d-flex flex-items-center">
105-
{% octicon "workflow" class="flex-shrink-0" %}
106-
<span class="ml-2">/guides/building-and-testing-java-with-maven</span>
107-
</footer>
108-
</a>
109-
</div>
110-
<div class="col-12 col-lg-4 mb-4">
111-
<a class="Box d-block hover-grow no-underline text-gray-dark" href="/actions/guides/building-and-testing-java-with-gradle">
112-
<div class="p-4">
113-
<h4>Building and testing Java with Gradle</h4>
114-
<p class="mt-2 mb-4">Use GitHub Actions to power CI in your Java project with Gradle.</p>
115-
<div class="d-flex">
116-
<span class="IssueLabel text-white bg-blue mr-2">Java</span>
117-
<span class="IssueLabel text-white bg-blue mr-2">CI</span>
118-
</div>
119-
</div>
120-
<footer class="border-top p-4 text-gray d-flex flex-items-center">
121-
{% octicon "workflow" class="flex-shrink-0" %}
122-
<span class="ml-2">/guides/building-and-testing-java-with-gradle</span>
123-
</footer>
124-
</a>
125-
</div>
126-
<div class="col-12 col-lg-4 mb-4">
127-
<a class="Box d-block hover-grow no-underline text-gray-dark" href="/actions/guides/building-and-testing-java-with-ant">
128-
<div class="p-4">
129-
<h4>Building and testing Java with Ant</h4>
130-
<p class="mt-2 mb-4">Use GitHub Actions to power CI in your Java project with Ant.</p>
131-
<div class="d-flex">
132-
<span class="IssueLabel text-white bg-blue mr-2">Java</span>
133-
<span class="IssueLabel text-white bg-blue mr-2">CI</span>
134-
</div>
135-
</div>
136-
<footer class="border-top p-4 text-gray d-flex flex-items-center">
137-
{% octicon "workflow" class="flex-shrink-0" %}
138-
<span class="ml-2">/guides/building-and-testing-java-with-ant</span>
139-
</footer>
140-
</a>
141-
</div>
142-
<div class="col-12 col-lg-4 mb-4">
143-
<a class="Box d-block hover-grow no-underline text-gray-dark" href="/actions/guides/publishing-nodejs-packages">
144-
<div class="p-4">
145-
<h4>Publishing Node.js packages</h4>
146-
<p class="mt-2 mb-4">Use GitHub Actions to push your Node.js package to GitHub Packages or npm.</p>
147-
<div class="d-flex">
148-
<span class="IssueLabel text-white bg-blue mr-2">JavaScript/TypeScript</span>
149-
<span class="IssueLabel text-white bg-blue mr-2">CI</span>
150-
</div>
151-
</div>
152-
<footer class="border-top p-4 text-gray d-flex flex-items-center">
153-
{% octicon "workflow" class="flex-shrink-0" %}
154-
<span class="ml-2">/guides/publishing-nodejs-packages</span>
155-
</footer>
156-
</a>
157-
</div>
73+
{% render 'code-example-card' for actionsCodeExamples as example %}
15874
</div>
15975

160-
<a href="/actions/guides" class="btn btn-outline mt-4">Show all guides {% octicon "arrow-right" %}</a>
76+
<button class="js-code-example-show-more btn btn-outline float-right">Show more {% octicon "arrow-right" %}</button>
77+
78+
<div class="js-code-example-no-results d-none py-4 text-center text-gray font-mktg">
79+
<div class="mb-3">{% octicon "search" width="24" %}</div>
80+
<h3 class="text-normal">Sorry, there is no result for <strong class="js-code-example-filter-value"></strong></h3>
81+
<p class="my-3 f4">It looks like we don't have an example that fits your filter.<br>Try another filter or add your code example</p>
82+
<a href="https://github.com/github/docs/blob/HEAD/data/variables/action_code_examples.yml">Learn how to add a code example {% octicon "arrow-right" %}</a>
83+
</div>
16184
</div>
85+
{% endif %}

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
| :- | :- | :- | :- |

0 commit comments

Comments
 (0)