Skip to content

Commit 5ee1665

Browse files
authored
Merge branch 'main' into patch-1
2 parents 77340f6 + f1b3ebe commit 5ee1665

5 files changed

Lines changed: 13 additions & 10 deletions

File tree

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

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/reference/events-that-trigger-workflows.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,7 @@ The `issue_comment` event occurs for comments on both issues and pull requests.
327327

328328
For example, you can choose to run the `pr_commented` job when comment events occur in a pull request, and the `issue_commented` job when comment events occur in an issue.
329329

330+
{% raw %}
330331
```yaml
331332
on: issue_comment
332333
@@ -349,6 +350,7 @@ jobs:
349350
- run: |
350351
echo "Comment on issue #${{ github.event.issue.number }}"
351352
```
353+
{% endraw %}
352354

353355
#### `issues`
354356

content/actions/reference/workflow-syntax-for-github-actions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -446,7 +446,7 @@ steps:
446446
uses: monacorp/action-name@main
447447
- name: My backup step
448448
if: {% raw %}${{ failure() }}{% endraw %}
449-
uses: actions/heroku@master
449+
uses: actions/heroku@1.0.0
450450
```
451451

452452
#### **`jobs.<job_id>.steps.name`**
@@ -492,7 +492,7 @@ jobs:
492492
steps:
493493
- name: My first step
494494
# Uses the default branch of a public repository
495-
uses: actions/heroku@master
495+
uses: actions/heroku@1.0.0
496496
- name: My second step
497497
# Uses a specific version tag of a public repository
498498
uses: actions/aws@v2.0.1
@@ -659,7 +659,7 @@ For built-in shell keywords, we provide the following defaults that are executed
659659

660660
- `cmd`
661661
- There doesn't seem to be a way to fully opt into fail-fast behavior other than writing your script to check each error code and respond accordingly. Because we can't actually provide that behavior by default, you need to write this behavior into your script.
662-
- `cmd.exe` will exit with the error level of the last program it executed, and it will and return the error code to the runner. This behavior is internally consistent with the previous `sh` and `pwsh` default behavior and is the `cmd.exe` default, so this behavior remains intact.
662+
- `cmd.exe` will exit with the error level of the last program it executed, and it will return the error code to the runner. This behavior is internally consistent with the previous `sh` and `pwsh` default behavior and is the `cmd.exe` default, so this behavior remains intact.
663663

664664
#### **`jobs.<job_id>.steps.with`**
665665

@@ -718,7 +718,7 @@ steps:
718718
entrypoint: /a/different/executable
719719
```
720720

721-
The `entrypoint` keyword is meant to use with Docker container actions, but you can also use it with JavaScript actions that don't define any inputs.
721+
The `entrypoint` keyword is meant to be used with Docker container actions, but you can also use it with JavaScript actions that don't define any inputs.
722722

723723
#### **`jobs.<job_id>.steps.env`**
724724

content/developers/overview/secret-scanning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Content-Length: 0123
7979
]
8080
```
8181

82-
The message body is a JSON array that contains one or more objects with the following contents. When multiple matches are found, {% data variables.product.prodname_dotcom %} may send a single message with more than one secret match.
82+
The message body is a JSON array that contains one or more objects with the following contents. When multiple matches are found, {% data variables.product.prodname_dotcom %} may send a single message with more than one secret match. Your endpoint should be able to handle requests with a large number of matches without timing out.
8383

8484
* **Token**: The value of the secret match.
8585
* **Type**: The unique name you provided to identify your regular expression.
@@ -139,7 +139,7 @@ func main() {
139139
fmt.Printf("Error preparing request: %s\n", err)
140140
os.Exit(1)
141141
}
142-
142+
143143
if len(os.Getenv("GITHUB_PRODUCTION_TOKEN")) == 0 {
144144
fmt.Println("Need to define environment variable GITHUB_PRODUCTION_TOKEN")
145145
os.Exit(1)

0 commit comments

Comments
 (0)