Skip to content

Commit baaeff0

Browse files
authored
Merge branch 'main' into secret-scanning-many-matches
2 parents 6d56712 + a3de9af commit baaeff0

File tree

1,037 files changed

+10653
-4748
lines changed

Some content is hidden

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

1,037 files changed

+10653
-4748
lines changed

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

Lines changed: 6 additions & 10 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,17 +17,12 @@ 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-
- name: Check if any broken links
20+
run: script/check-english-links.js > broken_links.md
21+
- if: ${{ failure() }}
22+
name: Get title for issue
2123
id: check
22-
run: |
23-
if [ "$(grep 'All links are good' broken_links.md)" ]; then
24-
echo ::set-output name=continue::no
25-
else
26-
echo "::set-output name=continue::yes"
27-
echo "::set-output name=title::$(grep 'found on help.github.com' broken_links.md)"
28-
fi
29-
- if: ${{ steps.check.outputs.continue == 'yes' }}
24+
run: echo "::set-output name=title::$(head -1 broken_links.md)"
25+
- if: ${{ failure() }}
3026
name: Create issue from file
3127
uses: peter-evans/create-issue-from-file@35e304e2a12caac08c568247a2cb46ecd0c3ecc5
3228
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

.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

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,8 @@ You can browse existing issues to find something that needs help!
114114

115115
### Labels
116116
Labels can help you find an issue you'd like to help with.
117-
- The [`good-first-issue` label](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3Agood-first-issue) is for problems or updates we think are ideal for beginners.
117+
- The [`help wanted` label](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) is for problems or updates that anyone in the community can start working on.
118+
- The [`good first issue` label](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) is for problems or updates we think are ideal for beginners.
118119
- The [`content` label](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3Acontent) is for problems or updates in the content on docs.github.com. These will usually require some knowledge of Markdown.
119120
- The [`engineering` label](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3Aengineering) is for problems or updates in the docs.github.com website. These will usually require some knowledge of JavaScript/Node.js or YAML to fix.
120121

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: 37 additions & 108 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,37 @@ 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:
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
1937
- title: Self-Hosted Runner Group Access Changes
2038
date: '2020-10-16'
2139
href: https://github.blog/changelog/2020-10-16-github-actions-self-hosted-runner-group-access-changes/
22-
- title: Ability to change retention days for artifacts and logs
23-
date: '2020-10-08'
24-
href: https://github.blog/changelog/2020-10-08-github-actions-ability-to-change-retention-days-for-artifacts-and-logs
25-
- title: Deprecating set-env and add-path commands
26-
date: '2020-10-01'
27-
href: https://github.blog/changelog/2020-10-01-github-actions-deprecating-set-env-and-add-path-commands
28-
- title: Fine-tune access to external actions
29-
date: '2020-10-01'
30-
href: https://github.blog/changelog/2020-10-01-github-actions-fine-tune-access-to-external-actions
40+
3141
redirect_from:
3242
- /articles/automating-your-workflow-with-github-actions/
3343
- /articles/customizing-your-project-with-github-actions/
@@ -50,107 +60,26 @@ versions:
5060
<!-- {% link_with_intro /reference %} -->
5161

5262
<!-- Code examples -->
63+
{% assign actionsCodeExamples = site.data.variables.action_code_examples %}
64+
{% if actionsCodeExamples %}
5365
<div class="my-6 pt-6">
54-
<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>
5571

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

155-
<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>
15684
</div>
85+
{% endif %}

content/actions/learn-github-actions/introduction-to-github-actions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,15 @@ A job is a set of steps that execute on the same runner. By default, a workflow
4242

4343
#### Steps
4444

45-
A step is an individual task that can run commands (known as _actions_). Each step in a job executes on the same runner, allowing the actions in that job to share data with each other.
45+
A step is an individual task that can run commands in a job. A step can be either an _action_ or a shell command. Each step in a job executes on the same runner, allowing the actions in that job to share data with each other.
4646

4747
#### Actions
4848

4949
_Actions_ are standalone commands that are combined into _steps_ to create a _job_. Actions are the smallest portable building block of a workflow. You can create your own actions, or use actions created by the {% data variables.product.prodname_dotcom %} community. To use an action in a workflow, you must include it as a step.
5050

5151
#### Runners
5252

53-
A runner is a server that has the {% data variables.product.prodname_actions %} runner application installed. You can use a runner hosted by {% data variables.product.prodname_dotcom %}, or you can host your own. A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. For {% data variables.product.prodname_dotcom %}-hosted runners, each job in a workflow runs in a fresh virtual environment.
53+
A runner is a server that has the [{% data variables.product.prodname_actions %} runner application](https://github.com/actions/runner) installed. You can use a runner hosted by {% data variables.product.prodname_dotcom %}, or you can host your own. A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. For {% data variables.product.prodname_dotcom %}-hosted runners, each job in a workflow runs in a fresh virtual environment.
5454

5555
{% data variables.product.prodname_dotcom %}-hosted runners are based on Ubuntu Linux, Microsoft Windows, and macOS. For information on {% data variables.product.prodname_dotcom %}-hosted runners, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/virtual-environments-for-github-hosted-runners)." If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)."
5656

@@ -197,7 +197,7 @@ To help you understand how YAML syntax is used to create a workflow file, this s
197197
198198
#### Visualizing the workflow file
199199
200-
In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action. Steps 1 and 2 use prebuilt community actions. To find more prebuilt actions for your workflows, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)."
200+
In this diagram, you can see the workflow file you just created and how the {% data variables.product.prodname_actions %} components are organized in a hierarchy. Each step executes a single action or shell command. Steps 1 and 2 use prebuilt community actions. Steps 3 and 4 run shell commands directly on the runner. To find more prebuilt actions for your workflows, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)."
201201
202202
![Workflow overview](/assets/images/help/images/overview-actions-event.png)
203203

content/actions/managing-workflow-runs/re-running-a-workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ versions:
1010
{% data reusables.actions.enterprise-beta %}
1111
{% data reusables.actions.enterprise-github-hosted-runners %}
1212

13-
{% data reusables.repositories.permissions-statement-read %}
13+
{% data reusables.repositories.permissions-statement-write %}
1414

1515
{% data reusables.repositories.navigate-to-repo %}
1616
{% data reusables.repositories.actions-tab %}

0 commit comments

Comments
 (0)