Skip to content

Commit e8a7ce2

Browse files
committed
chore: Add missing code fence languages
1 parent 1a2de94 commit e8a7ce2

File tree

37 files changed

+106
-105
lines changed

37 files changed

+106
-105
lines changed

content/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ https://github-images.s3.amazonaws.com/enterprise/2.20/assets/images/help/profil
249249

250250
Sometimes you want to link to a Dotcom-only article in Enterprise content and you don't want the link to be Enterprise-ified. To prevent the transformation, write the link using HTML and add a class of `dotcom-only`. For example:
251251

252-
```
252+
```html
253253
<a href="/github/site-policy/github-terms-of-service" class="dotcom-only">GitHub's Terms of Service</a>
254254
```
255255

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

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,20 +47,21 @@ The Docker `ENTRYPOINT` instruction has a _shell_ form and _exec_ form. The Dock
4747

4848
If you configure your container to use the _exec_ form of the `ENTRYPOINT` instruction, the `args` configured in the action's metadata file won't run in a command shell. If the action's `args` contain an environment variable, the variable will not be substituted. For example, using the following _exec_ format will not print the value stored in `$GITHUB_SHA`, but will instead print `"$GITHUB_SHA"`.
4949

50-
```
50+
```dockerfile
5151
ENTRYPOINT ["echo $GITHUB_SHA"]
5252
```
5353

5454
If you want variable substitution, then either use the _shell_ form or execute a shell directly. For example, using the following _exec_ format, you can execute a shell to print the value stored in the `GITHUB_SHA` environment variable.
5555

56-
```
56+
```dockerfile
5757
ENTRYPOINT ["sh", "-c", "echo $GITHUB_SHA"]
58-
````
58+
```
5959

6060
To supply `args` defined in the action's metadata file to a Docker container that uses the _exec_ form in the `ENTRYPOINT`, we recommend creating a shell script called `entrypoint.sh` that you call from the `ENTRYPOINT` instruction:
6161

6262
##### Example *Dockerfile*
63-
```
63+
64+
``` dockerfile
6465
# Container image that runs your code
6566
FROM debian:9.5-slim
6667

content/actions/creating-actions/setting-exit-codes-for-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ For more information, see "[Creating a JavaScript action](/articles/creating-a-j
4040

4141
If you are creating a Docker container action, you can set a failure exit code in your `entrypoint.sh` script. For example:
4242

43-
```
43+
```shell
4444
if <condition> ; then
4545
echo "Game over!"
4646
exit 1

content/actions/guides/building-and-testing-nodejs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ steps:
219219

220220
The example above creates an *.npmrc* file with the following contents:
221221

222-
```
222+
```ini
223223
//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}
224224
@octocat:registry=https://registry.npmjs.org/
225225
always-auth=true

content/actions/guides/caching-dependencies-to-speed-up-workflows.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -123,14 +123,14 @@ A cache key can include any of the contexts, functions, literals, and operators
123123
Using expressions to create a `key` allows you to automatically create a new cache when dependencies have changed. For example, you can create a `key` using an expression that calculates the hash of an npm `package-lock.json` file.
124124

125125
{% raw %}
126-
```
126+
```yaml
127127
npm-${{ hashFiles('package-lock.json') }}
128128
```
129129
{% endraw %}
130130

131131
{% data variables.product.prodname_dotcom %} evaluates the expression `hash "package-lock.json"` to derive the final `key`.
132132

133-
```
133+
```yaml
134134
npm-d5ea0750
135135
```
136136

@@ -143,7 +143,7 @@ You can provide a list of restore keys to use when there is a cache miss on `key
143143
#### Example using multiple restore keys
144144

145145
{% raw %}
146-
```
146+
```yaml
147147
restore-keys: |
148148
npm-foobar-${{ hashFiles('package-lock.json') }}
149149
npm-foobar-
@@ -154,7 +154,7 @@ restore-keys: |
154154
The runner evaluates the expressions, which resolve to these `restore-keys`:
155155

156156
{% raw %}
157-
```
157+
```yaml
158158
restore-keys: |
159159
npm-foobar-d5ea0750
160160
npm-foobar-

content/actions/guides/publishing-nodejs-packages.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ jobs:
7979
8080
In the example above, the `setup-node` action creates an *.npmrc* file on the runner with the following contents:
8181

82-
```
82+
```ini
8383
//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}
8484
registry=https://registry.npmjs.org/
8585
always-auth=true
@@ -122,7 +122,7 @@ jobs:
122122

123123
The `setup-node` action creates an *.npmrc* file on the runner. When you use the `scope` input to the `setup-node` action, the *.npmrc* file includes the scope prefix. By default, the `setup-node` action sets the scope in the *.npmrc* file to the account that contains that workflow file.
124124

125-
```
125+
```ini
126126
//npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN}
127127
@octocat:registry=https://npm.pkg.github.com
128128
always-auth=true

content/actions/guides/storing-workflow-data-as-artifacts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ jobs:
115115
116116
You can define a custom retention period for individual artifacts created by a workflow. When using a workflow to create a new artifact, you can use `retention-days` with the `upload-artifact` action. This example demonstrates how to set a custom retention period of 5 days for the artifact named `my-artifact`:
117117

118-
```
118+
```yaml
119119
- name: 'Upload Artifact'
120120
uses: actions/upload-artifact@v2
121121
with:

content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ If setting environment variables is not practical, you can set the proxy configu
3737

3838
An example _.env_ proxy configuration is shown below:
3939

40-
```
40+
```ini
4141
https_proxy=http://proxy.local:8080
4242
no_proxy=example.com,myserver.local:443
4343
```

content/actions/managing-workflow-runs/adding-a-workflow-status-badge.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,30 +34,30 @@ https://github.com/<OWNER>/<REPOSITORY>/workflows/<WORKFLOW_FILE_PATH>/badge.svg
3434

3535
This Markdown example adds a status badge for a workflow with the name "Greet Everyone." The `OWNER` of the repository is the `actions` organization and the `REPOSITORY` name is `hello-world`.
3636

37-
```
37+
```markdown
3838
![example workflow name](https://github.com/actions/hello-world/workflows/Greet%20Everyone/badge.svg)
3939
```
4040

4141
### Using a workflow file path
4242

4343
This Markdown example adds a status badge for a workflow with the file path `.github/workflows/main.yml`. The `OWNER` of the repository is the `actions` organization and the `REPOSITORY` name is `hello-world`.
4444

45-
```
45+
```markdown
4646
![example workflow file path](https://github.com/actions/hello-world/workflows/.github/workflows/main.yml/badge.svg)
4747
```
4848

4949
### Using the `branch` parameter
5050

5151
This Markdown example adds a status badge for a branch with the name `feature-1`.
5252

53-
```
53+
```markdown
5454
![example branch parameter](https://github.com/actions/hello-world/workflows/Greet%20Everyone/badge.svg?branch=feature-1)
5555
```
5656

5757
### Using the `event` parameter
5858

5959
This Markdown example adds a badge that displays the status of workflow runs triggered by the `pull_request` event.
6060

61-
```
61+
```markdown
6262
![example event parameter](https://github.com/actions/hello-world/workflows/Greet%20Everyone/badge.svg?event=pull_request)
6363
```

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,7 @@ During the execution of a workflow, the runner generates temporary files that ca
253253

254254
**Warning:** Powershell does not use UTF-8 by default. Make sure you write files using the correct encoding. For example, you need to set UTF-8 encoding when you set the path:
255255

256-
```
256+
```yaml
257257
steps:
258258
- run: echo "mypath" | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
259259
```
@@ -287,7 +287,7 @@ For multiline strings, you may use a delimiter with the following syntax.
287287
##### Example
288288
289289
In this example, we use `EOF` as a delimiter and set the `JSON_RESPONSE` environment variable to the value of the curl response.
290-
```
290+
```yaml
291291
steps:
292292
- name: Set the value
293293
id: step_one

content/admin/enterprise-management/evacuating-a-cluster-node.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,40 +14,40 @@ If you're taking a node offline that has any data services (like git, pages, or
1414

1515
1. Find the `uuid` of the node in with the `ghe-config`command.
1616

17-
```
17+
```shell
1818
$ ghe-config cluster._hostname_.uuid
1919
```
2020

2121
2. You'll need to monitor the status of your node while the data is being copied. Ideally, the node shouldn't be taken offline until the copying is complete. To monitor the status of your node, run any of the following commands:
2222

2323
For Git
24-
```
24+
```shell
2525
ghe-spokes evac-status
2626
```
2727
For {% data variables.product.prodname_pages %}
28-
```
28+
```shell
2929
echo "select count(*) from pages_replicas where host = 'pages-server-<uuid>'" | ghe-dbconsole -y
3030
```
3131
For storage
32-
```
32+
```shell
3333
ghe-storage evacuation-status
3434
```
3535

3636
3. After the copying is complete, you can evacuate the storage service. Run any of the following commands:
3737

3838
For Git
39-
```
39+
```shell
4040
ghe-spokes server evacuate git-server-<uuid>
4141
```
4242
For {% data variables.product.prodname_pages %}
43-
```
43+
```shell
4444
ghe-dpages evacuate pages-server-<uuid>
4545
```
4646
For storage, take the node offline
47-
```
47+
```shell
4848
ghe-storage offline storage-server-<uuid>
4949
```
5050
then evacuate
51-
```
51+
```shell
5252
ghe-storage evacuate storage-server-<uuid>
5353
```

content/admin/enterprise-management/initializing-the-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The names of the nodes can be any valid hostname you choose. The names are set a
4646

4747
Specify the first cluster node you configured as the MySQL primary via `mysql-server` and `mysql-master`.
4848

49-
```
49+
```ini
5050
[cluster]
5151
mysql-master = ghe-data-node-1
5252
redis-master = ghe-data-node-1

content/admin/enterprise-management/migrating-elasticsearch-indices-to-github-enterprise-server-214-or-later.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ versions:
1919

2020
The migration script checks for any `search` indices first while the appliance is online. Migrating `search` indices can take a few minutes to a few days, depending on their size. For an example of large indices, these indices took a couple of days to migrate in our test environment.
2121

22-
```
22+
```shell
2323
admin@ip-172-31-2-141:~$ curl -s http://localhost:9200/_cat/indices?v | sort -n -k 6
2424
green open blog-1 1 0 0 0 144b 144b
2525
green open projects-1 1 0 0 0 144b 144b
@@ -72,7 +72,7 @@ The `webhook` indices start with `hookshot-logs-`.
7272

7373
You can see available indices on your appliance using curl.
7474

75-
```
75+
```shell
7676
admin@ip-172-31-2-141:~$ curl -s http://localhost:9200/_cat/indices?v | sort -n -k 6
7777
green open blog-1 1 0 0 0 144b 144b
7878
green open projects-1 1 0 0 0 144b 144b

content/admin/github-actions/manually-syncing-actions-from-githubcom.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ This example demonstrates using the `actions-sync` tool to sync an individual ac
6161
* You can sync multiple actions by replacing the `--repo-name` parameter with `--repo-name-list` or `--repo-name-list-file`. For more information, see the [`actions-sync` README](https://github.com/actions/actions-sync#actions-sync).
6262
1. After the action repository is created on your enterprise instance, people in your enterprise can use the destination repository to reference the action in their workflows. For the example action shown above:
6363

64-
```
64+
```yaml
6565
uses: synced-actions/docker-build-push-action@v1
6666
```
6767

content/admin/policies/creating-a-pre-receive-hook-script.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ You can test a pre-receive hook script locally before you create or update it on
9494

9595
2. Create a file called `Dockerfile.dev` containing:
9696

97-
```
97+
```dockerfile
9898
FROM gliderlabs/alpine:3.3
9999
RUN \
100100
apk add --no-cache git openssh bash && \
@@ -116,7 +116,7 @@ You can test a pre-receive hook script locally before you create or update it on
116116

117117
3. Create a test pre-receive script called `always_reject.sh`. This example script will reject all pushes, which is useful for locking a repository:
118118

119-
```
119+
```shell
120120
#!/usr/bin/env bash
121121

122122
echo "error: rejecting all pushes"

content/admin/user-management/migrating-to-internal-repositories.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ If you don't have private mode enabled, the migration script will have no effect
3333

3434
1. Connect to the administrative shell. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/admin/installation/accessing-the-administrative-shell-ssh)."
3535
2. Navigate to the `/data/github/current` directory.
36-
```
36+
```shell
3737
cd /data/github/current
3838
```
3939
3. Run the migration command.
40-
```
40+
```shell
4141
sudo bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log
4242
```
4343

content/developers/apps/creating-a-github-app-from-a-manifest.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Name | Type | Description
8080

8181
This example uses a form on a web page with a button that triggers the `POST` request for a user account:
8282

83-
```
83+
```html
8484
<form action="https://github.com/settings/apps/new?state=abc123" method="post">
8585
Create a GitHub App Manifest: <input type="text" name="manifest" id="manifest"><br>
8686
<input type="submit" value="Submit">
@@ -111,7 +111,7 @@ This example uses a form on a web page with a button that triggers the `POST` re
111111
```
112112
This example uses a form on a web page with a button that triggers the `POST` request for an organization account. Replace `ORGANIZATION` with the name of the organization account where you want to create the app.
113113

114-
```
114+
```html
115115
<form action="https://github.com/organizations/<em>ORGANIZATION</em>/settings/apps/new?state=abc123" method="post">
116116
Create a GitHub App Manifest: <input type="text" name="manifest" id="manifest"><br>
117117
<input type="submit" value="Submit">

content/developers/apps/creating-ci-tests-with-the-checks-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -724,7 +724,7 @@ To push to a repository, your app must have write permissions for "Repository co
724724

725725
In order to commit files, Git must know which [username](/articles/setting-your-username-in-git/) and [email](/articles/setting-your-commit-email-address-in-git/) to associate with the commit. Add two more environment variables in your `.env` file to store the name (`GITHUB_APP_USER_NAME`) and email (`GITHUB_APP_USER_EMAIL`) settings. Your name can be the name of your app and the email can be any email you'd like for this example. For example:
726726

727-
```
727+
```ini
728728
GITHUB_APP_USER_NAME=Octoapp
729729
GITHUB_APP_USER_EMAIL[email protected]
730730
```

content/developers/apps/identifying-and-authorizing-users-for-github-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Name | Type | Description
8989

9090
By default, the response takes the following form. The response parameters `expires_in`, `refresh_token`, and `refresh_token_expires_in` are only returned when you enable the beta for expiring user-to-server access tokens.
9191

92-
```
92+
```json
9393
{
9494
"access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a",
9595
"expires_in": "28800",

content/developers/overview/secret-scanning.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Create a public, internet accessible HTTP endpoint at the URL you provided to us
6161

6262
##### Example POST sent to your endpoint
6363

64-
```
64+
```http
6565
POST / HTTP/1.1
6666
Host: HOST
6767
Accept: */*
@@ -95,7 +95,7 @@ Assuming you receive the following message, the code snippets below demonstrate
9595
The code also assumes you've set an environment variable called `GITHUB_PRODUCTION_TOKEN` with a generated PAT (https://github.com/settings/tokens). The token does not need any permissions set.
9696

9797
**Sample message sent to verify endpoint**
98-
```
98+
```http
9999
POST / HTTP/1.1
100100
Host: HOST
101101
Accept: */*

content/github/building-a-strong-community/manually-creating-a-single-issue-template-for-your-repository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can add YAML frontmatter to each issue template to pre-fill the issue title,
1818

1919
Here is example YAML front matter.
2020

21-
```
21+
```yaml
2222
---
2323
name: Tracking issue
2424
about: Use this template for tracking new features.

content/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-using-the-command-line.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,14 @@ For example, if you and another person both edited the file _styleguide.md_ on t
4646
4. Open your favorite text editor, such as [Atom](https://atom.io/), and navigate to the file that has merge conflicts.
4747
5. To see the beginning of the merge conflict in your file, search the file for the conflict marker `<<<<<<<`. When you open the file in your text editor, you'll see the changes from the HEAD or base branch after the line `<<<<<<< HEAD`. Next, you'll see `=======`, which divides your changes from the changes in the other branch, followed by `>>>>>>> BRANCH-NAME`. In this example, one person wrote "open an issue" in the base or HEAD branch and another person wrote "ask your question in IRC" in the compare branch or `branch-a`.
4848

49-
```
50-
If you have questions, please
51-
<<<<<<< HEAD
52-
open an issue
53-
=======
54-
ask your question in IRC.
55-
>>>>>>> branch-a
56-
````
49+
```
50+
If you have questions, please
51+
<<<<<<< HEAD
52+
open an issue
53+
=======
54+
ask your question in IRC.
55+
>>>>>>> branch-a
56+
```
5757
{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %} In this example, both changes are incorporated into the final merge:
5858
5959
```shell

content/github/collaborating-with-issues-and-pull-requests/working-with-pre-receive-hooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Pre-receive hooks run tests on code pushed to a repository to ensure contributio
1111

1212
If your push isn't accepted, you'll see an error message corresponding to the failed pre-receive hook.
1313

14-
```
14+
```shell
1515
$ git push
1616
Counting objects: 3, done.
1717
Delta compression using up to 4 threads.

0 commit comments

Comments
 (0)