Skip to content

Commit 27d2502

Browse files
shati-patelshati-patel
authored
Merge branch 'main' into patch-1
2 parents 506e6c0 + f86c8fb commit 27d2502

File tree

1,869 files changed

+26085
-15047
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,869 files changed

+26085
-15047
lines changed

‎.devcontainer.json

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Codespaces environment for docs.github.com
2+
// For format details, see https://aka.ms/vscode-remote/devcontainer.json
3+
{
4+
"name": "docs.github.com",
5+
"service": "container-doc",
6+
"settings": {
7+
"terminal.integrated.shell.linux": "/bin/bash",
8+
"cSpell.language": ",en"
9+
},
10+
// Install pre-requisites, and start to serve docs.github.com locally
11+
"postCreateCommand": "npm install && npm start",
12+
"forwardPorts": [4000],
13+
// Visual Studio Code extensions which help authoring for docs.github.com.
14+
"extensions": [
15+
"yzhang.markdown-all-in-one",
16+
"streetsidesoftware.code-spell-checker"
17+
]
18+
}

‎.editorconfig

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
charset = utf-8
7+
trim_trailing_whitespace = true
8+
insert_final_newline = true
9+
10+
[*.md]
11+
trim_trailing_whitespace = false

‎.eslintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dist/

‎.eslintrc.js

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
module.exports = {
2+
env: {
3+
browser: true,
4+
commonjs: true,
5+
es2020: true,
6+
node: true
7+
},
8+
parser: 'babel-eslint',
9+
extends: [
10+
'eslint:recommended',
11+
'standard'
12+
],
13+
parserOptions: {
14+
ecmaVersion: 11
15+
},
16+
rules: {
17+
},
18+
overrides: [
19+
{
20+
files: [
21+
'**/tests/**/*.js'
22+
],
23+
env: {
24+
jest: true
25+
}
26+
}
27+
]
28+
}

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ Thanks again!
2222

2323
### Check off the following:
2424
- [ ] All of the tests are passing.
25-
- [ ] I have reviewed my changes in staging.
25+
- [ ] I have reviewed my changes in staging. (look for the **deploy-to-heroku** link in your pull request, then click **View deployment**)
2626
- [ ] For content changes, I have reviewed the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md)
2727
- [ ] For content changes, I have reviewed the [Content style guide for GitHub Docs](https://github.com/github/docs/blob/main/contributing/content-style-guide.md).

‎.github/allowed-actions.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
// can be added it this list.
55

66
module.exports = [
7-
'actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16', //actions/cache@v2.1.2
8-
'actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675', //actions/checkout@v2.3.3
7+
'actions/cache@0781355a23dac32fd3bac414512f4b903437991a', //actions/cache@v2.1.3
8+
'actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f', //actions/checkout@v2.3.4
99
'actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9', //actions/script@v3.0.0
1010
'actions/labeler@5f867a63be70efff62b767459b009290364495eb', //actions/labeler@v2.2.0
1111
'actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d', //actions/setup-node@v1.4.4
1212
'actions/setup-ruby@5f29a1cd8dfebf420691c4c9a0e832e2fae5a526', //actions/setup-ruby@v1.1.2
13-
'actions/stale@44f9eae0adddf72dbf3eedfacc999f70afcec1a8', //actions/stale@v3.0.12
13+
'actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4', //actions/stale@v3.0.13
1414
'crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688',
1515
'dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911',
1616
'docker://chinthakagodawita/autoupdate-action:v1',
@@ -22,7 +22,7 @@ module.exports = [
2222
'juliangruber/find-pull-request-action@64d55773c959748ad30a4184f4dc102af1669f7b',
2323
'juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512',
2424
'pascalgn/automerge-action@c9bd182',
25-
'peter-evans/create-issue-from-file@35e304e2a12caac08c568247a2cb46ecd0c3ecc5',
25+
'peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326',
2626
'peter-evans/create-pull-request@938e6aea6f8dbdaced2064e948cb806c77fe87b8',
2727
'rachmari/actions-add-new-issue-to-column@1a459ef92308ba7c9c9dc2fcdd72f232495574a9',
2828
'rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e',

‎.github/workflows/60-days-stale-check.yml

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
name: 60 Days Stale Check
22
on:
33
schedule:
4-
- cron: "40 16 * * *" # Run each day at 16:40 UTC / 8:40 PST
4+
- cron: '40 16 * * *' # Run each day at 16:40 UTC / 8:40 PST
55

66
jobs:
77
stale:
88
runs-on: ubuntu-latest
99
steps:
10-
- uses: actions/stale@44f9eae0adddf72dbf3eedfacc999f70afcec1a8
11-
with:
12-
repo-token: ${{ secrets.GITHUB_TOKEN }}
13-
stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.'
14-
stale-pr-message: 'This PR is stale because it has been open 60 days with no activity.'
15-
days-before-stale: 60
16-
days-before-close: -1
17-
only-labels: 'engineering'
18-
stale-issue-label: 'stale'
19-
stale-pr-label: 'stale'
20-
10+
- uses: actions/stale@af4072615903a8b031f986d25b1ae3bf45ec44d4
11+
with:
12+
repo-token: ${{ secrets.GITHUB_TOKEN }}
13+
stale-issue-message: 'This issue is stale because it has been open 60 days with no activity.'
14+
stale-pr-message: 'This PR is stale because it has been open 60 days with no activity.'
15+
days-before-stale: 60
16+
days-before-close: -1
17+
only-labels: 'engineering'
18+
stale-issue-label: 'stale'
19+
stale-pr-label: 'stale'
20+
exempt-pr-labels: 'never-stale'
21+
exempt-issue-labels: 'never-stale'

‎.github/workflows/auto-label-prs.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
name: Auto label Pull Requests
22
on:
3-
- pull_request
3+
pull_request:
44

55
jobs:
66
triage:
77
if: github.repository == 'github/docs-internal'
88
runs-on: ubuntu-latest
99
steps:
10-
- uses: actions/labeler@5f867a63be70efff62b767459b009290364495eb
11-
with:
12-
repo-token: "${{ secrets.GITHUB_TOKEN }}"
10+
- uses: actions/labeler@5f867a63be70efff62b767459b009290364495eb
11+
with:
12+
repo-token: '${{ secrets.GITHUB_TOKEN }}'

‎.github/workflows/automerge-dependencies.yml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
name: Auto Merge Dependency Updates
22

33
on:
4-
- pull_request
5-
- pull_request_review
4+
pull_request:
5+
paths:
6+
- 'package*.json'
7+
- 'Gemfile*'
8+
- 'Dockerfile'
9+
- '.github/workflows/**'
10+
pull_request_review:
11+
types:
12+
- edited
13+
- submitted
614

715
jobs:
816
run:

‎.github/workflows/automerge.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ jobs:
2323
if: contains(github.event.pull_request.labels.*.name, 'automerge') || contains(github.event.pull_request.labels.*.name, 'autosquash')
2424
steps:
2525
- name: automerge
26-
uses: "pascalgn/automerge-action@c9bd182"
26+
uses: 'pascalgn/automerge-action@c9bd182'
2727
env:
28-
GITHUB_TOKEN: "${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}"
29-
MERGE_METHOD_LABELS: "automerge=merge,autosquash=squash"
30-
MERGE_COMMIT_MESSAGE: "pull-request-title"
31-
MERGE_METHOD: "merge"
32-
MERGE_FORKS: "true"
33-
MERGE_RETRIES: "50"
34-
MERGE_RETRY_SLEEP: "10000" # ten seconds
35-
UPDATE_LABELS: "automerge,autosquash"
36-
UPDATE_METHOD: "merge"
28+
GITHUB_TOKEN: '${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}'
29+
MERGE_METHOD_LABELS: 'automerge=merge,autosquash=squash'
30+
MERGE_COMMIT_MESSAGE: 'pull-request-title'
31+
MERGE_METHOD: 'merge'
32+
MERGE_FORKS: 'true'
33+
MERGE_RETRIES: '50'
34+
MERGE_RETRY_SLEEP: '10000' # ten seconds
35+
UPDATE_LABELS: 'automerge,autosquash'
36+
UPDATE_METHOD: 'merge'

‎.github/workflows/browser-test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
# Even if if doesn't do anything
2727
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
2828
name: Checkout
29-
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
29+
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
3030

3131
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
3232
name: Install

‎.github/workflows/check-all-english-links.yml

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,32 @@
11
name: Check all English links
22

33
on:
4+
workflow_dispatch:
45
schedule:
5-
- cron: "40 19 * * *" # once a day at 19:40 UTC / 11:40 PST
6+
- cron: '40 19 * * *' # once a day at 19:40 UTC / 11:40 PST
67

78
jobs:
89
check_all_english_links:
910
name: Check all links
1011
if: github.repository == 'github/docs-internal'
1112
runs-on: ubuntu-latest
1213
steps:
13-
- uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
14-
- name: npm ci
15-
run: npm ci
16-
- name: npm run build
17-
run: npm run build
18-
- name: Run script
19-
run: script/check-external-links en > broken_links.md
20-
- name: Check if any broken links
21-
id: check
22-
run: |
23-
if [ "$(grep 'All links are good' broken_links.md)" ]; then
24-
echo ::set-output name=continue::no
25-
else
26-
echo "::set-output name=continue::yes"
27-
echo "::set-output name=title::$(grep 'found on help.github.com' broken_links.md)"
28-
fi
29-
- if: ${{ steps.check.outputs.continue == 'yes' }}
30-
name: Create issue from file
31-
uses: peter-evans/create-issue-from-file@35e304e2a12caac08c568247a2cb46ecd0c3ecc5
32-
with:
33-
token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
34-
title: ${{ steps.check.outputs.title }}
35-
content-filepath: ./broken_links.md
36-
labels: broken link report
14+
- uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
15+
- name: npm ci
16+
run: npm ci
17+
- name: npm run build
18+
run: npm run build
19+
- name: Run script
20+
run: script/check-english-links.js > broken_links.md
21+
- if: ${{ failure() }}
22+
name: Get title for issue
23+
id: check
24+
run: echo "::set-output name=title::$(head -1 broken_links.md)"
25+
- if: ${{ failure() }}
26+
name: Create issue from file
27+
uses: peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326
28+
with:
29+
token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
30+
title: ${{ steps.check.outputs.title }}
31+
content-filepath: ./broken_links.md
32+
labels: broken link report

‎.github/workflows/codeql.yml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
name: "CodeQL analysis"
1+
name: CodeQL analysis
22

33
on:
44
push:
55
paths:
6-
- '**/*.js'
7-
- '.github/workflows/codeql.yml'
6+
- '**/*.js'
7+
- '.github/workflows/codeql.yml'
88

99
jobs:
1010
build:
11-
runs-on: ubuntu-latest
11+
runs-on: ubuntu-latest
1212

1313
steps:
14-
- uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
15-
- uses: github/codeql-action/init@v1
16-
with:
17-
languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp} (not YET ruby, sorry!)
18-
- uses: github/codeql-action/analyze@v1
19-
continue-on-error: true
14+
- uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
15+
- uses: github/codeql-action/init@v1
16+
with:
17+
languages: javascript # comma separated list of values from {go, python, javascript, java, cpp, csharp} (not YET ruby, sorry!)
18+
- uses: github/codeql-action/analyze@v1
19+
continue-on-error: true

‎.github/workflows/crowdin.yml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name: Crowdin Sync
33
on:
44
workflow_dispatch:
55
schedule:
6-
- cron: "33 2 * * *" # every day at 2:33 UTC at least until automerge is working
6+
- cron: '33 2 * * *' # every day at 2:33 UTC at least until automerge is working
77

88
jobs:
99
sync_with_crowdin:
@@ -12,15 +12,15 @@ jobs:
1212
runs-on: ubuntu-latest
1313
steps:
1414
- name: Checkout
15-
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
15+
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
1616

1717
- name: Sync
1818
uses: crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688
1919
with:
2020
upload_translations: false
2121
download_translations: true
2222
create_pull_request: true
23-
23+
2424
# Using a custom config temporarily to avoid clobbering the existing crowdin.yml
2525
# that is used by the github-help-docs OAuth integration.
2626
config: 'crowdin.yml'
@@ -35,17 +35,15 @@ jobs:
3535
crowdin_branch_name: main
3636

3737
env:
38-
# Using an @octoglot token instead of the default Actions-provided GITHUB_TOKEN here
38+
# Using an @octoglot token instead of the default Actions-provided GITHUB_TOKEN here
3939
# so that subsequent workflows will be able to run on the pull request created by this workflow.
4040
GITHUB_TOKEN: ${{ secrets.OCTOGLOT_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
4141

4242
# This is a numeric id, not to be confused with Crowdin API v1 "project identifier" string
4343
# See "API v2" on https://crowdin.com/project/<your-project>/settings#api
4444
CROWDIN_PROJECT_ID: ${{ secrets.CROWDIN_PROJECT_ID }}
45-
45+
4646
# A personal access token, not to be confused with Crowdin API v1 "API key"
4747
# See https://crowdin.com/settings#api-key to generate a token
4848
# This token was created by logging into Crowdin with the octoglot user
4949
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
50-
51-

‎.github/workflows/dry-run-sync-algolia-search-indices.yml

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,23 @@ jobs:
99
if: github.repository == 'github/docs-internal'
1010
runs-on: ubuntu-latest
1111
steps:
12-
- name: checkout
13-
uses: actions/checkout@a81bbbf8298c0fa03ea29cdc473d45769f953675
14-
- uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
15-
with:
16-
node-version: 14.x
17-
- name: cache node modules
18-
uses: actions/cache@d1255ad9362389eac595a9ae406b8e8cb3331f16
19-
with:
20-
path: ~/.npm
21-
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
22-
restore-keys: |
23-
${{ runner.os }}-node-
24-
- name: npm ci
25-
run: npm ci
26-
- name: (Dry run) sync indices
27-
env:
28-
ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
29-
ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
30-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
31-
run: npm run sync-search-dry-run
12+
- name: checkout
13+
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
14+
- uses: actions/setup-node@56899e050abffc08c2b3b61f3ec6a79a9dc3223d
15+
with:
16+
node-version: 14.x
17+
- name: cache node modules
18+
uses: actions/cache@0781355a23dac32fd3bac414512f4b903437991a
19+
with:
20+
path: ~/.npm
21+
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
22+
restore-keys: |
23+
${{ runner.os }}-node-
24+
- name: npm ci
25+
run: npm ci
26+
- name: (Dry run) sync indices
27+
env:
28+
ALGOLIA_APPLICATION_ID: ${{ secrets.ALGOLIA_APPLICATION_ID }}
29+
ALGOLIA_API_KEY: ${{ secrets.ALGOLIA_API_KEY }}
30+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
31+
run: npm run sync-search-dry-run

0 commit comments

Comments
 (0)