Skip to content

Commit

Permalink
repo sync (#16715)
Browse files Browse the repository at this point in the history
* Improve documentation issue no #1034

Done with the minor fixes for open issue number #1034 .

* Increasing the importance

I wanted to delete a branch, but I couldn't in spite of reading this document. The problem was, the branch I wanted to delete was the default branch. 
Even though it is stated in this document, it was not given enough importance that everyone would see it.

* typo

A small type in the comments

* Update setting-up-your-development-environment-to-create-a-github-app.md

Fix two small typos.

* properly capitalize "macOS"

* Clarify GH password requirements

* Change " to `

As done in the description of `master`

* " to ` in DE

* " to ` in PT

* " to ` in RU

* Fix typo metadata-syntax-for-github-actions.md

Fix typo for metadata-syntax-for-github-actions#outputs-for-composite-run-steps-actions

* chore: Remove bolding from headings

* Removed deprecated echo set-env instruction

* fix typo (#1516)

Co-authored-by: hubwriter <hubwriter@github.com>

* Remove extraneous grammar period which breaks the compare URL (#1252)

* Remove extraneous grammar period which breaks the compare URL

* Update data/reusables/repositories/two-dot-diff-comparison-example-urls.md

Co-authored-by: Nick Schonning <nschonni@gmail.com>

Co-authored-by: Nick Schonning <nschonni@gmail.com>
Co-authored-by: hubwriter <hubwriter@github.com>

* Revert "" to ` in RU"

This reverts commit d484fd6.

* Revert "" to ` in PT"

This reverts commit fab62f0.

* Revert "" to ` in DE"

This reverts commit 78abcd6.

* Change md

This squashes all the translation commits and their deletion.

* Update content/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository.md

Co-authored-by: Felicity Chapman <felicitymay@github.com>

Co-authored-by: Atharva Shirdhankar <72031540+StarTrooper08@users.noreply.github.com>
Co-authored-by: Aakarsh B <aakarshbiju@gmail.com>
Co-authored-by: Aritra Roy Gosthipaty <aritra.born2fly@gmail.com>
Co-authored-by: Guilherme Macedo <guilherme@gmacedo.com>
Co-authored-by: Stephen Wade <stephen@stephenwade.me>
Co-authored-by: Shao Yang Hong <hongsy2006@gmail.com>
Co-authored-by: a2br <62328077+a2br@users.noreply.github.com>
Co-authored-by: Cas van Dinter <casvd@hotmail.com>
Co-authored-by: Nick Schonning <nschonni@gmail.com>
Co-authored-by: Antoine Rondelet <rondelet.antoine@gmail.com>
Co-authored-by: Shati Patel <42641846+shati-patel@users.noreply.github.com>
Co-authored-by: Meg Bird <megbird@github.com>
Co-authored-by: ねず <39144575+wonda-tea-coffee@users.noreply.github.com>
Co-authored-by: hubwriter <hubwriter@github.com>
Co-authored-by: Ilia <ilia@wearebond.com>
Co-authored-by: a2br <a2br@users.noreply.github.com>
Co-authored-by: Felicity Chapman <felicitymay@github.com>
Co-authored-by: Jason Etcovitch <jasonetco@github.com>
  • Loading branch information
19 people authored Dec 2, 2020
1 parent 9a49997 commit 87fb2ce
Show file tree
Hide file tree
Showing 19 changed files with 144 additions and 140 deletions.
4 changes: 2 additions & 2 deletions content/actions/creating-actions/about-actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ You can build Docker container and JavaScript actions. Actions require a metadat
| Type | Operating system |
| ---- | ------------------- |
| Docker container | Linux |
| JavaScript | Linux, MacOS, Windows |
| Composite run steps | Linux, MacOS, Windows |
| JavaScript | Linux, macOS, Windows |
| Composite run steps | Linux, macOS, Windows |

#### Docker container actions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,19 @@ Docker and JavaScript actions require a metadata file. The metadata filename mus

Action metadata files use YAML syntax. If you're new to YAML, you can read "[Learn YAML in five minutes](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes)."

### **`name`**
### `name`

**Required** The name of your action. {% data variables.product.prodname_dotcom %} displays the `name` in the **Actions** tab to help visually identify actions in each job.

### **`author`**
### `author`

**Optional** The name of the action's author.

### **`description`**
### `description`

**Required** A short description of the action.

### **`inputs`**
### `inputs`

**Optional** Input parameters allow you to specify data that the action expects to use during runtime. {% data variables.product.prodname_dotcom %} stores input parameters as environment variables. Input ids with uppercase letters are converted to lowercase during runtime. We recommended using lowercase input ids.

Expand All @@ -57,23 +57,23 @@ When you specify an input to an action in a workflow file or use a default input

For example, if a workflow defined the numOctocats and octocatEyeColor inputs, the action code could read the values of the inputs using the `INPUT_NUMOCTOCATS` and `INPUT_OCTOCATEYECOLOR` environment variables.

#### **`inputs.<input_id>`**
#### `inputs.<input_id>`

**Required** A `string` identifier to associate with the input. The value of `<input_id>` is a map of the input's metadata. The `<input_id>` must be a unique identifier within the `inputs` object. The `<input_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.

#### **`inputs.<input_id>.description`**
#### `inputs.<input_id>.description`

**Required** A `string` description of the input parameter.

#### **`inputs.<input_id>.required`**
#### `inputs.<input_id>.required`

**Required** A `boolean` to indicate whether the action requires the input parameter. Set to `true` when the parameter is required.

#### **`inputs.<input_id>.default`**
#### `inputs.<input_id>.default`

**Optional** A `string` representing the default value. The default value is used when an input parameter isn't specified in a workflow file.

### **`outputs`**
### `outputs`

**Optional** Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.

Expand All @@ -87,15 +87,15 @@ outputs:
description: 'The sum of the inputs'
```

#### **`outputs.<output_id>`**
#### `outputs.<output_id>`

**Required** A `string` identifier to associate with the output. The value of `<output_id>` is a map of the output's metadata. The `<output_id>` must be a unique identifier within the `outputs` object. The `<output_id>` must start with a letter or `_` and contain only alphanumeric characters, `-`, or `_`.

#### **`outputs.<output_id>.description`**
#### `outputs.<output_id>.description`

**Required** A `string` description of the output parameter.

### **`outputs`** for composite run steps actions
### `outputs` for composite run steps actions

**Optional** `outputs` use the same parameters as `outputs.<output_id>` and `outputs.<output_id>.description` (see "[`outputs` for {% data variables.product.prodname_actions %}](/actions/creating-actions/metadata-syntax-for-github-actions#outputs)"), but also includes the `value` token.

Expand All @@ -116,12 +116,12 @@ runs:
```
{% endraw %}

#### **`outputs.<output_id.value>`**
#### `outputs.<output_id>.value`
**Required** The value that the output parameter will be mapped to. You can set this to a `string` or an expression with context. For example, you can use the `steps` context to set the `value` of an output to the output value of a step.

For more information on how to use context and expression syntax, see "[Context and expression syntax for {% data variables.product.prodname_actions %}](/actions/reference/context-and-expression-syntax-for-github-actions)".

### **`runs`** for JavaScript actions
### `runs` for JavaScript actions

**Required** Configures the path to the action's code and the application used to execute the code.

Expand All @@ -133,15 +133,15 @@ runs:
main: 'main.js'
```

#### **`runs.using`**
#### `runs.using`

**Required** The application used to execute the code specified in [`main`](#runsmain).

#### **`runs.main`**
#### `runs.main`

**Required** The file that contains your action code. The application specified in [`using`](#runsusing) executes this file.

#### **`pre`**
#### `pre`

**Optional** Allows you to run a script at the start of a job, before the `main:` action begins. For example, you can use `pre:` to run a prerequisite setup script. The application specified with the [`using`](#runsusing) syntax will execute this file. The `pre:` action always runs by default but you can override this using [`pre-if`](#pre-if).

Expand All @@ -155,7 +155,7 @@ runs:
post: 'cleanup.js'
```

#### **`pre-if`**
#### `pre-if`

**Optional** Allows you to define conditions for the `pre:` action execution. The `pre:` action will only run if the conditions in `pre-if` are met. If not set, then `pre-if` defaults to `always()`.
Note that the `step` context is unavailable, as no steps have run yet.
Expand All @@ -167,7 +167,7 @@ In this example, `cleanup.js` only runs on Linux-based runners:
pre-if: 'runner.os == linux'
```

#### **`post`**
#### `post`

**Optional** Allows you to run a script at the end of a job, once the `main:` action has completed. For example, you can use `post:` to terminate certain processes or remove unneeded files. The application specified with the [`using`](#runsusing) syntax will execute this file.

Expand All @@ -182,7 +182,7 @@ runs:

The `post:` action always runs by default but you can override this using `post-if`.

#### **`post-if`**
#### `post-if`

**Optional** Allows you to define conditions for the `post:` action execution. The `post:` action will only run if the conditions in `post-if` are met. If not set, then `post-if` defaults to `always()`.

Expand All @@ -193,19 +193,19 @@ For example, this `cleanup.js` will only run on Linux-based runners:
post-if: 'runner.os == linux'
```

### **`runs`** for composite run steps actions
### `runs` for composite run steps actions

**Required** Configures the path to the composite action, and the application used to execute the code.

#### **`runs.using`**
#### `runs.using`

**Required** To use a composite run steps action, set this to `"composite"`.

#### **`runs.steps`**
#### `runs.steps`

**Required** The run steps that you plan to run in this action.

##### **`runs.steps.run`**
##### `runs.steps.run`

**Required** The command you want to run. This can be inline or a script in your action repository:
```yaml
Expand All @@ -228,27 +228,27 @@ runs:

For more information, see "[`github context`](/actions/reference/context-and-expression-syntax-for-github-actions#github-context)".

##### **`runs.steps.shell`**
##### `runs.steps.shell`

**Required** The shell where you want to run the command. You can use any of the shells listed [here](/actions/reference/workflow-syntax-for-github-actions#using-a-specific-shell).

##### **`runs.steps.name`**
##### `runs.steps.name`

**Optional** The name of the composite run step.

##### **`runs.steps.id`**
##### `runs.steps.id`

**Optional** A unique identifier for the step. You can use the `id` to reference the step in contexts. For more information, see "[Context and expression syntax for {% data variables.product.prodname_actions %}](/actions/reference/context-and-expression-syntax-for-github-actions)".

##### **`runs.steps.env`**
##### `runs.steps.env`

**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite run step.

##### **`runs.steps.working-directory`**
##### `runs.steps.working-directory`

**Optional** Specifies the working directory where the command is run.

### **`runs`** for Docker actions
### `runs` for Docker actions

**Required** Configures the image used for the Docker action.

Expand All @@ -268,11 +268,11 @@ runs:
image: 'docker://debian:stretch-slim'
```

#### **`runs.using`**
#### `runs.using`

**Required** You must set this value to `'docker'`.

#### **`pre-entrypoint`**
#### `pre-entrypoint`

**Optional** Allows you to run a script before the `entrypoint` action begins. For example, you can use `pre-entrypoint:` to run a prerequisite setup script. {% data variables.product.prodname_actions %} uses `docker run` to launch this action, and runs the script inside a new container that uses the same base image. This means that the runtime state is different from the main `entrypoint` container, and any states you require must be accessed in either the workspace, `HOME`, or as a `STATE_` variable. The `pre-entrypoint:` action always runs by default but you can override this using [`pre-if`](#pre-if).

Expand All @@ -290,21 +290,21 @@ runs:
entrypoint: 'main.sh'
```

#### **`runs.image`**
#### `runs.image`

**Required** The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` application will execute this file.

#### **`runs.env`**
#### `runs.env`

**Optional** Specifies a key/value map of environment variables to set in the container environment.

#### **`runs.entrypoint`**
#### `runs.entrypoint`

**Optional** Overrides the Docker `ENTRYPOINT` in the `Dockerfile`, or sets it if one wasn't already specified. Use `entrypoint` when the `Dockerfile` does not specify an `ENTRYPOINT` or you want to override the `ENTRYPOINT` instruction. If you omit `entrypoint`, the commands you specify in the Docker `ENTRYPOINT` instruction will execute. The Docker `ENTRYPOINT` instruction has a _shell_ form and _exec_ form. The Docker `ENTRYPOINT` documentation recommends using the _exec_ form of the `ENTRYPOINT` instruction.

For more information about how the `entrypoint` executes, see "[Dockerfile support for {% data variables.product.prodname_actions %}](/actions/creating-actions/dockerfile-support-for-github-actions/#entrypoint)."

#### **`post-entrypoint`**
#### `post-entrypoint`

**Optional** Allows you to run a cleanup script once the `runs.entrypoint` action has completed. {% data variables.product.prodname_actions %} uses `docker run` to launch this action. Because {% data variables.product.prodname_actions %} runs the script inside a new container using the same base image, the runtime state is different from the main `entrypoint` container. You can access any state you need in either the workspace, `HOME`, or as a `STATE_` variable. The `post-entrypoint:` action always runs by default but you can override this using [`post-if`](#post-if).

Expand All @@ -318,7 +318,7 @@ runs:
post-entrypoint: 'cleanup.sh'
```

#### **`runs.args`**
#### `runs.args`

**Optional** An array of strings that define the inputs for a Docker container. Inputs can include hardcoded strings. {% data variables.product.prodname_dotcom %} passes the `args` to the container's `ENTRYPOINT` when the container starts up.

Expand All @@ -344,7 +344,7 @@ runs:
```
{% endraw %}

### **`branding`**
### `branding`

You can use a color and [Feather](https://feathericons.com/) icon to create a badge to personalize and distinguish your action. Badges are shown next to your action name in [{% data variables.product.prodname_marketplace %}](https://github.com/marketplace?type=actions).

Expand All @@ -356,11 +356,11 @@ branding:
color: 'green'
```

#### **`branding.color`**
#### `branding.color`

The background color of the badge. Can be one of: `white`, `yellow`, `blue`, `green`, `orange`, `red`, `purple`, or `gray-dark`.

#### **`branding.icon`**
#### `branding.icon`

The name of the [Feather](https://feathericons.com/) icon to use.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The following operating systems are supported for the self-hosted runner applica
- Windows Server 2016 64-bit
- Windows Server 2019 64-bit

#### MacOS
#### macOS

- macOS 10.13 (High Sierra) or later

Expand Down
2 changes: 1 addition & 1 deletion content/actions/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Printing "Hello, World!" is a great way to explore the basic set up and syntax o
# When the event is triggered, GitHub Actions will run the jobs indicated
jobs:
say_hello:
# Uses a ubuntu-lates runner to complete the requested steps
# Uses a ubuntu-latest runner to complete the requested steps
runs-on: ubuntu-latest
steps:
- run: |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ In order to use property dereference syntax, the property name must:
- start with `a-Z` or `_`.
- be followed by `a-Z` `0-9` `-` or `_`.

#### **`github` context**
#### `github` context

The `github` context contains information about the workflow run and the event that triggered the run. You can read most of the `github` context data in environment variables. For more information about environment variables, see "[Using environment variables](/actions/automating-your-workflow-with-github-actions/using-environment-variables)."

Expand Down Expand Up @@ -103,7 +103,7 @@ The `github` context contains information about the workflow run and the event t
| `github.workflow` | `string` | The name of the workflow. If the workflow file doesn't specify a `name`, the value of this property is the full path of the workflow file in the repository. |
| `github.workspace` | `string` | The default working directory for steps and the default location of your repository when using the [`checkout`](https://github.com/actions/checkout) action. |

#### **`env` context**
#### `env` context

The `env` context contains environment variables that have been set in a workflow, job, or step. For more information about setting environment variables in your workflow, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#env)."

Expand All @@ -117,7 +117,7 @@ You can only use the `env` context in the value of the `with` and `name` keys, o
| `env.<env name>` | `string` | The value of a specific environment variable. |


#### **`job` context**
#### `job` context

The `job` context contains information about the currently running job.

Expand All @@ -133,7 +133,7 @@ The `job` context contains information about the currently running job.
| `job.services.<service id>.ports` | `object` | The exposed ports of the service container. |
| `job.status` | `string` | The current status of the job. Possible values are `success`, `failure`, or `cancelled`. |

#### **`steps` context**
#### `steps` context

The `steps` context contains information about the steps in the current job that have already run.

Expand All @@ -145,7 +145,7 @@ The `steps` context contains information about the steps in the current job that
| `steps.<step id>.outcome` | `string` | The result of a completed step before [`continue-on-error`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstepscontinue-on-error) is applied. Possible values are `success`, `failure`, `cancelled`, or `skipped`. When a `continue-on-error` step fails, the `outcome` is `failure`, but the final `conclusion` is `success`. |
| `steps.<step id>.outputs.<output name>` | `string` | The value of a specific output. |

#### **`runner` context**
#### `runner` context

The `runner` context contains information about the runner that is executing the current job.

Expand All @@ -155,7 +155,7 @@ The `runner` context contains information about the runner that is executing the
| `runner.temp` | `string` | The path of the temporary directory for the runner. This directory is guaranteed to be empty at the start of each job, even on self-hosted runners. |
| `runner.tool_cache` | `string` | The path of the directory containing some of the preinstalled tools for {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". |

#### **`needs` context**
#### `needs` context

The `needs` context contains outputs from all jobs that are defined as a dependency of the current job. For more information on defining job dependencies, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idneeds)."

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,8 @@ The software tools included in {% data variables.product.prodname_dotcom %}-host
* [Ubuntu 16.04 LTS](https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu1604-README.md)
* [Windows Server 2019](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2019-Readme.md)
* [Windows Server 2016](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2016-Readme.md)
* [MacOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md)
* [MacOS 11.0](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-11.0-Readme.md)
* [macOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md)
* [macOS 11.0](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-11.0-Readme.md)

{% data reusables.github-actions.ubuntu-runner-preview %}
{% data reusables.github-actions.macos-runner-preview %}
Expand Down
Loading

0 comments on commit 87fb2ce

Please sign in to comment.