Skip to content

Commit 3231aeb

Browse files
committed
chore: Remove bolding from headings
1 parent 5c72e58 commit 3231aeb

File tree

4 files changed

+104
-104
lines changed

4 files changed

+104
-104
lines changed

content/actions/creating-actions/metadata-syntax-for-github-actions.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@ Docker and JavaScript actions require a metadata file. The metadata filename mus
2222

2323
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)."
2424

25-
### **`name`**
25+
### `name`
2626

2727
**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.
2828

29-
### **`author`**
29+
### `author`
3030

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

33-
### **`description`**
33+
### `description`
3434

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

37-
### **`inputs`**
37+
### `inputs`
3838

3939
**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.
4040

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

5858
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.
5959

60-
#### **`inputs.<input_id>`**
60+
#### `inputs.<input_id>`
6161

6262
**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 `_`.
6363

64-
#### **`inputs.<input_id>.description`**
64+
#### `inputs.<input_id>.description`
6565

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

68-
#### **`inputs.<input_id>.required`**
68+
#### `inputs.<input_id>.required`
6969

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

72-
#### **`inputs.<input_id>.default`**
72+
#### `inputs.<input_id>.default`
7373

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

76-
### **`outputs`**
76+
### `outputs`
7777

7878
**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.
7979

@@ -87,15 +87,15 @@ outputs:
8787
description: 'The sum of the inputs'
8888
```
8989

90-
#### **`outputs.<output_id>`**
90+
#### `outputs.<output_id>`
9191

9292
**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 `_`.
9393

94-
#### **`outputs.<output_id>.description`**
94+
#### `outputs.<output_id>.description`
9595

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

98-
### **`outputs`** for composite run steps actions
98+
### `outputs` for composite run steps actions
9999

100100
**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.
101101

@@ -116,12 +116,12 @@ runs:
116116
```
117117
{% endraw %}
118118

119-
#### **`outputs.<output_id.value>`**
119+
#### `outputs.<output_id.value>`
120120
**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.
121121

122122
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)".
123123

124-
### **`runs`** for JavaScript actions
124+
### `runs` for JavaScript actions
125125

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

@@ -133,15 +133,15 @@ runs:
133133
main: 'main.js'
134134
```
135135

136-
#### **`runs.using`**
136+
#### `runs.using`
137137

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

140-
#### **`runs.main`**
140+
#### `runs.main`
141141

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

144-
#### **`pre`**
144+
#### `pre`
145145

146146
**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).
147147

@@ -155,7 +155,7 @@ runs:
155155
post: 'cleanup.js'
156156
```
157157

158-
#### **`pre-if`**
158+
#### `pre-if`
159159

160160
**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()`.
161161
Note that the `step` context is unavailable, as no steps have run yet.
@@ -167,7 +167,7 @@ In this example, `cleanup.js` only runs on Linux-based runners:
167167
pre-if: 'runner.os == linux'
168168
```
169169

170-
#### **`post`**
170+
#### `post`
171171

172172
**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.
173173

@@ -182,7 +182,7 @@ runs:
182182

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

185-
#### **`post-if`**
185+
#### `post-if`
186186

187187
**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()`.
188188

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

196-
### **`runs`** for composite run steps actions
196+
### `runs` for composite run steps actions
197197

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

200-
#### **`runs.using`**
200+
#### `runs.using`
201201

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

204-
#### **`runs.steps`**
204+
#### `runs.steps`
205205

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

208-
##### **`runs.steps.run`**
208+
##### `runs.steps.run`
209209

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

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

231-
##### **`runs.steps.shell`**
231+
##### `runs.steps.shell`
232232

233233
**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).
234234

235-
##### **`runs.steps.name`**
235+
##### `runs.steps.name`
236236

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

239-
##### **`runs.steps.id`**
239+
##### `runs.steps.id`
240240

241241
**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)".
242242

243-
##### **`runs.steps.env`**
243+
##### `runs.steps.env`
244244

245245
**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 "[email protected]" %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite run step.
246246

247-
##### **`runs.steps.working-directory`**
247+
##### `runs.steps.working-directory`
248248

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

251-
### **`runs`** for Docker actions
251+
### `runs` for Docker actions
252252

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

@@ -268,11 +268,11 @@ runs:
268268
image: 'docker://debian:stretch-slim'
269269
```
270270

271-
#### **`runs.using`**
271+
#### `runs.using`
272272

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

275-
#### **`pre-entrypoint`**
275+
#### `pre-entrypoint`
276276

277277
**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).
278278

@@ -290,21 +290,21 @@ runs:
290290
entrypoint: 'main.sh'
291291
```
292292

293-
#### **`runs.image`**
293+
#### `runs.image`
294294

295295
**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.
296296

297-
#### **`runs.env`**
297+
#### `runs.env`
298298

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

301-
#### **`runs.entrypoint`**
301+
#### `runs.entrypoint`
302302

303303
**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.
304304

305305
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)."
306306

307-
#### **`post-entrypoint`**
307+
#### `post-entrypoint`
308308

309309
**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).
310310

@@ -318,7 +318,7 @@ runs:
318318
post-entrypoint: 'cleanup.sh'
319319
```
320320

321-
#### **`runs.args`**
321+
#### `runs.args`
322322

323323
**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.
324324

@@ -344,7 +344,7 @@ runs:
344344
```
345345
{% endraw %}
346346

347-
### **`branding`**
347+
### `branding`
348348

349349
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).
350350

@@ -356,11 +356,11 @@ branding:
356356
color: 'green'
357357
```
358358

359-
#### **`branding.color`**
359+
#### `branding.color`
360360

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

363-
#### **`branding.icon`**
363+
#### `branding.icon`
364364

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

content/actions/reference/context-and-expression-syntax-for-github-actions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ In order to use property dereference syntax, the property name must:
7575
- start with `a-Z` or `_`.
7676
- be followed by `a-Z` `0-9` `-` or `_`.
7777

78-
#### **`github` context**
78+
#### `github` context
7979

8080
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)."
8181

@@ -103,7 +103,7 @@ The `github` context contains information about the workflow run and the event t
103103
| `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. |
104104
| `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. |
105105

106-
#### **`env` context**
106+
#### `env` context
107107

108108
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)."
109109

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

119119

120-
#### **`job` context**
120+
#### `job` context
121121

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

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

136-
#### **`steps` context**
136+
#### `steps` context
137137

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

@@ -145,7 +145,7 @@ The `steps` context contains information about the steps in the current job that
145145
| `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`. |
146146
| `steps.<step id>.outputs.<output name>` | `string` | The value of a specific output. |
147147

148-
#### **`runner` context**
148+
#### `runner` context
149149

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

@@ -155,7 +155,7 @@ The `runner` context contains information about the runner that is executing the
155155
| `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. |
156156
| `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)". |
157157

158-
#### **`needs` context**
158+
#### `needs` context
159159

160160
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)."
161161

0 commit comments

Comments
 (0)