Skip to content

Commit ab9ec27

Browse files
rachmarirachmari
authored
Fix commonmark issues in data reusables (github#37424)
1 parent 14c365c commit ab9ec27

119 files changed

Lines changed: 857 additions & 857 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.

‎content/actions/automating-builds-and-tests/building-and-testing-powershell.md‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,6 @@ jobs:
7272

7373
![Screenshot of a workflow run failure for a Pester test. Test reports "Expected $true, but got $false" and "Error: Process completed with exit code 1."](/assets/images/help/repository/actions-failed-pester-test-updated.png)
7474

75-
7675
* `Invoke-Pester Unit.Tests.ps1 -Passthru` - Uses Pester to execute tests defined in a file called `Unit.Tests.ps1`. For example, to perform the same test described above, the `Unit.Tests.ps1` will contain the following:
7776
```
7877
Describe "Check results file is present" {

‎content/actions/creating-actions/creating-a-composite-action.md‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -34,28 +34,28 @@ Before you begin, you'll create a repository on {% ifversion ghae %}{% data vari
3434

3535
1. From your terminal, change directories into your new repository.
3636

37-
```shell{:copy}
38-
cd hello-world-composite-action
39-
```
37+
```shell{:copy}
38+
cd hello-world-composite-action
39+
```
4040

4141
2. In the `hello-world-composite-action` repository, create a new file called `goodbye.sh`, and add the following example code:
4242

43-
```bash{:copy}
44-
echo "Goodbye"
45-
```
43+
```bash{:copy}
44+
echo "Goodbye"
45+
```
4646

4747
3. From your terminal, make `goodbye.sh` executable.
4848

49-
```shell{:copy}
50-
chmod +x goodbye.sh
51-
```
49+
```shell{:copy}
50+
chmod +x goodbye.sh
51+
```
5252

5353
1. From your terminal, check in your `goodbye.sh` file.
54-
```shell{:copy}
55-
git add goodbye.sh
56-
git commit -m "Add goodbye script"
57-
git push
58-
```
54+
```shell{:copy}
55+
git add goodbye.sh
56+
git commit -m "Add goodbye script"
57+
git push
58+
```
5959

6060
## Creating an action metadata file
6161

@@ -101,18 +101,18 @@ Before you begin, you'll create a repository on {% ifversion ghae %}{% data vari
101101
102102
1. From your terminal, check in your `action.yml` file.
103103
104-
```shell{:copy}
105-
git add action.yml
106-
git commit -m "Add action"
107-
git push
108-
```
104+
```shell{:copy}
105+
git add action.yml
106+
git commit -m "Add action"
107+
git push
108+
```
109109

110110
1. From your terminal, add a tag. This example uses a tag called `v1`. For more information, see "[AUTOTITLE](/actions/creating-actions/about-custom-actions#using-release-management-for-actions)."
111111

112-
```shell{:copy}
113-
git tag -a -m "Description of this release" v1
114-
git push --follow-tags
115-
```
112+
```shell{:copy}
113+
git tag -a -m "Description of this release" v1
114+
git push --follow-tags
115+
```
116116

117117
## Testing out your action in a workflow
118118

‎content/actions/creating-actions/creating-a-docker-container-action.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ Before you begin, you'll need to create a {% data variables.product.prodname_dot
4949

5050
1. From your terminal, change directories into your new repository.
5151

52-
```shell{:copy}
53-
cd hello-world-docker-action
54-
```
52+
```shell{:copy}
53+
cd hello-world-docker-action
54+
```
5555

5656
## Creating a Dockerfile
5757

@@ -109,33 +109,33 @@ Next, the script gets the current time and sets it as an output variable that ac
109109

110110
1. Add the following code to your `entrypoint.sh` file.
111111

112-
**entrypoint.sh**
113-
```shell{:copy}
114-
#!/bin/sh -l
112+
**entrypoint.sh**
113+
```shell{:copy}
114+
#!/bin/sh -l
115115
116-
echo "Hello $1"
117-
time=$(date)
116+
echo "Hello $1"
117+
time=$(date)
118118
{%- ifversion actions-save-state-set-output-envs %}
119-
echo "time=$time" >> $GITHUB_OUTPUT
119+
echo "time=$time" >> $GITHUB_OUTPUT
120120
{%- else %}
121-
echo "::set-output name=time::$time"
121+
echo "::set-output name=time::$time"
122122
{%- endif %}
123-
```
124-
If `entrypoint.sh` executes without any errors, the action's status is set to `success`. You can also explicitly set exit codes in your action's code to provide an action's status. For more information, see "[AUTOTITLE](/actions/creating-actions/setting-exit-codes-for-actions)."
123+
```
124+
If `entrypoint.sh` executes without any errors, the action's status is set to `success`. You can also explicitly set exit codes in your action's code to provide an action's status. For more information, see "[AUTOTITLE](/actions/creating-actions/setting-exit-codes-for-actions)."
125125

126126

127127
1. Make your `entrypoint.sh` file executable. Git provides a way to explicitly change the permission mode of a file so that it doesn’t get reset every time there is a clone/fork.
128128

129-
```shell{:copy}
130-
$ git add entrypoint.sh
131-
$ git update-index --chmod=+x entrypoint.sh
132-
```
129+
```shell{:copy}
130+
$ git add entrypoint.sh
131+
$ git update-index --chmod=+x entrypoint.sh
132+
```
133133

134134
1. Optionally, to check the permission mode of the file in the git index, run the following command.
135135

136-
```shell{:copy}
137-
$ git ls-files --stage entrypoint.sh
138-
```
136+
```shell{:copy}
137+
$ git ls-files --stage entrypoint.sh
138+
```
139139

140140
An output like `100755 e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 0 entrypoint.sh` means the file has the executable permission. In this example, `755` denotes the executable permission.
141141

‎content/actions/creating-actions/dockerfile-support-for-github-actions.md‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,10 @@ printf '\n'
8989
```
9090

9191
Your code must be executable. Make sure the `entrypoint.sh` file has `execute` permissions before using it in a workflow. You can modify the permission from your terminal using this command:
92-
``` sh
93-
chmod +x entrypoint.sh
94-
```
92+
93+
``` sh
94+
chmod +x entrypoint.sh
95+
```
9596

9697
When an `ENTRYPOINT` shell script is not executable, you'll receive an error similar to this:
9798

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -268,9 +268,9 @@ For more information, see "[AUTOTITLE](/actions/learn-github-actions/contexts#gi
268268

269269
**Example: Using contexts**
270270

271-
This step only runs when the event type is a `pull_request` and the event action is `unassigned`.
271+
This step only runs when the event type is a `pull_request` and the event action is `unassigned`.
272272

273-
```yaml
273+
```yaml
274274
steps:
275275
- run: echo This event is a pull request that had an assignee removed.
276276
if: {% raw %}${{ github.event_name == 'pull_request' && github.event.action == 'unassigned' }}{% endraw %}

‎content/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,10 +158,12 @@ kubectl create secret generic pre-defined-secret \
158158
--from-literal=github_app_installation_id=654321 \
159159
--from-literal=github_app_private_key='-----BEGIN RSA PRIVATE KEY-----********'
160160
```
161+
161162
In your copy of the [`values.yaml`](https://github.com/actions/actions-runner-controller/blob/master/charts/gha-runner-scale-set/values.yaml) pass the secret name as a reference.
163+
162164
```yaml
163165
githubConfigSecret: pre-defined-secret
164-
```
166+
```
165167

166168
#### Option 2: Specify values in your `values.yaml` file
167169

‎content/actions/hosting-your-own-runners/managing-self-hosted-runners/configuring-the-self-hosted-runner-application-as-a-service.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ You can manage the runner service in the Windows **Services** application, or yo
7676

7777
1. Alternatively, the command takes an optional `user` argument to install the service as a different user.
7878

79-
```shell
80-
./svc.sh install USERNAME
81-
```
79+
```shell
80+
./svc.sh install USERNAME
81+
```
8282

8383
{% endlinux %}
8484

‎content/actions/using-workflows/workflow-syntax-for-github-actions.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -359,9 +359,9 @@ You can use the `if` conditional to prevent a step from running unless a conditi
359359

360360
### Example: Using contexts
361361

362-
This step only runs when the event type is a `pull_request` and the event action is `unassigned`.
362+
This step only runs when the event type is a `pull_request` and the event action is `unassigned`.
363363

364-
```yaml
364+
```yaml
365365
steps:
366366
- name: My first step
367367
if: {% raw %}${{ github.event_name == 'pull_request' && github.event.action == 'unassigned' }}{% endraw %}

‎content/admin/configuration/configuring-network-settings/configuring-an-outbound-web-proxy-server.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Your instance validates the hostnames for proxy exclusion using the list of IANA
6262
{% data reusables.enterprise_installation.ssh-into-instance %}
6363
1. Enter the following command, replacing COMMA-SEPARATED-TLD-LIST with a comma-separated list of TLDs.
6464

65-
```shell
66-
$ ghe-config noproxy.exception-tld-list "COMMA-SEPARATED-TLD-LIST"
67-
```
65+
```shell
66+
$ ghe-config noproxy.exception-tld-list "COMMA-SEPARATED-TLD-LIST"
67+
```
6868
{% data reusables.enterprise.apply-configuration %}

‎content/admin/configuration/configuring-network-settings/configuring-dns-nameservers.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ The nameservers you specify must resolve {% data variables.location.product_loca
3232

3333
2. To edit your nameservers, use the `ghe-setup-network` command in visual mode. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-setup-network)."
3434

35-
```shell
36-
ghe-setup-network -v
37-
```
35+
```shell
36+
ghe-setup-network -v
37+
```
3838

3939
5. To add your new nameserver entries to {% data variables.location.product_location %}, run the following:
4040

41-
```shell
42-
sudo service resolvconf restart
43-
sudo service dnsmasq restart
44-
```
41+
```shell
42+
sudo service resolvconf restart
43+
sudo service dnsmasq restart
44+
```

0 commit comments

Comments
 (0)