Skip to content

Commit 218d08f

Browse files
authored
Branch was updated using the 'autoupdate branch' Actions workflow.
2 parents 962eedc + c7870f4 commit 218d08f

File tree

76 files changed

+1056
-450
lines changed

Some content is hidden

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

76 files changed

+1056
-450
lines changed

.env.example

-3
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
11
ALGOLIA_API_KEY=
22
ALGOLIA_APPLICATION_ID=
33
ALLOW_TRANSLATION_COMMITS=
4-
EARLY_ACCESS_HOSTNAME=
5-
EARLY_ACCESS_SHARED_SECRET=
6-
GITHUB_TOKEN=

.github/ISSUE_TEMPLATE/improve-existing-docs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ labels:
77
assignees: ''
88
---
99
<!--
10-
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
10+
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.
1111
-->
1212

1313
<!--
1414
For questions, ask in Discussions: https://github.com/github/docs/discussions
1515
16-
Before you file an issue read the:
16+
Before you file an issue read the:
1717
- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
1818
- Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md
1919

.github/ISSUE_TEMPLATE/improve-the-site.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ assignees: ''
77
---
88

99
<!--
10-
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT https://github.com/github/docs-content/issues/new/choose INSTEAD.
10+
HUBBERS BEWARE! THE GITHUB/DOCS REPO IS PUBLIC TO THE ENTIRE INTERNET. OPEN AN ISSUE IN GITHUB/DOCS-CONTENT INSTEAD.
1111
-->
1212

1313
<!--
1414
For questions, ask in Discussions: https://github.com/github/docs/discussions
1515
16-
Before you file an issue read the:
16+
Before you file an issue read the:
1717
- Code of Conduct: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
1818
- Contributing guide: https://github.com/github/docs/blob/main/CONTRIBUTING.md
1919
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: Close unwanted pull requests
2+
on:
3+
pull_request:
4+
paths:
5+
- '.github/workflows/**'
6+
- '.github/CODEOWNERS'
7+
- 'translations/**'
8+
- 'assets/fonts/**'
9+
- 'data/graphql/**'
10+
- 'lib/graphql/**'
11+
- 'lib/redirects/**'
12+
- 'lib/webhooks/**'
13+
jobs:
14+
close_unwanted_pull_requests:
15+
if: github.repository == 'github/docs' && github.event.pull_request.user.login != 'Octomerger'
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
19+
with:
20+
script: |
21+
await github.issues.createComment({
22+
...context.repo,
23+
issue_number: context.payload.pull_request.number,
24+
body:
25+
`Thanks for contributing! We do not accept community changes to these files at this time.
26+
- '.github/workflows/**'
27+
- '.github/CODEOWNERS'
28+
- 'translations/**'
29+
- 'assets/fonts/**'
30+
- 'data/graphql/**'
31+
- 'lib/graphql/**'
32+
- 'lib/redirects/**'
33+
- 'lib/webhooks/**'`
34+
})
35+
await github.issues.update({
36+
...context.repo,
37+
issue_number: context.payload.pull_request.number,
38+
state: 'closed'
39+
})

.github/workflows/sync-algolia-search-indices.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ jobs:
3737
if: failure()
3838
env:
3939
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
40-
SLACK_MESSAGE: The last Algolia workflow run for ${{github.repository}} failed. See https://github.com/github/docs-internal/actions?query=workflow%3AAlgolia
40+
SLACK_MESSAGE: The last Algolia workflow run for ${{github.repository}} failed. Search actions for `workflow:Algolia`

.github/workflows/test.yml

+13-10
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
with:
2828
cancel_others: 'false'
2929
github_token: ${{ github.token }}
30-
paths: '[".github/workflows/test.yml",".node-version", ".npmrc", "app.json", "content/**", "data/**","lib/**", "Dockerfile", "feature-flags.json", "Gemfile", "Gemfile.lock", "middleware/**", "node_modules/**","package.json", "package-lock.json", "server.js", "tests/**", "translations/**", "Procfile", "webpack.config.js"]'
30+
paths: '[".github/workflows/test.yml", ".node-version", ".npmrc", "app.json", "content/**", "data/**","lib/**", "Dockerfile", "feature-flags.json", "Gemfile", "Gemfile.lock", "middleware/**", "node_modules/**","package.json", "package-lock.json", "server.js", "tests/**", "translations/**", "Procfile", "webpack.config.js"]'
3131

3232
test:
3333
needs: see_if_should_skip
@@ -44,6 +44,9 @@ jobs:
4444
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
4545
name: Check out repo
4646
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
47+
with:
48+
# Enables cloning the Early Access repo later with the relevant PAT
49+
persist-credentials: 'false'
4750

4851
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
4952
name: Setup node
@@ -70,19 +73,19 @@ jobs:
7073
name: Install dependencies
7174
run: npm ci
7275

73-
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
74-
name: Run build script
76+
- name: Clone early access
77+
if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' && github.repository == 'github/docs-internal' }}
78+
run: npm run heroku-postbuild
79+
env:
80+
DOCUBOT_REPO_PAT: ${{ secrets.DOCUBOT_REPO_PAT }}
81+
GIT_BRANCH: ${{ github.ref }}
82+
83+
- name: Run build script
84+
if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' && github.repository != 'github/docs-internal' }}
7585
run: npm run build
7686

7787
- if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
7888
name: Run tests
7989
run: npx jest tests/${{ matrix.test-group }}/
8090
env:
8191
NODE_OPTIONS: '--max_old_space_size=4096'
82-
83-
- name: Send Slack notification if workflow fails
84-
uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815
85-
if: failure() && github.ref == 'early-access'
86-
env:
87-
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
88-
SLACK_MESSAGE: 'Tests are failing on the `early-access` branch. https://github.com/github/docs-internal/tree/early-access'

.gitignore

+11-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
.algolia-cache
22
.DS_Store
33
.env
4-
node_modules
4+
/node_modules/
55
npm-debug.log
6-
coverage
6+
coverage/
77
.linkinator
8-
broken_links.md
8+
/assets/images/early-access
9+
/content/early-access
10+
/data/early-access
911
dist
12+
13+
# blc: broken link checker
14+
blc_output.log
15+
blc_output_internal.log
16+
/dist/
17+
broken_links.md

assets/images/octicons/README.md

-16
Original file line numberDiff line numberDiff line change
@@ -1,16 +0,0 @@
1-
## Importing Aftermarket Octicons
2-
3-
#### Background
4-
Some octicons are missing from the project's current version of the `octicons` gem. Because this project is being replaced soon and updating `octicons` would require [significant changes](https://github.com/github/docs-internal/issues/6250#issuecomment-339730405), new octicons should be added manually as needed, via the following process:
5-
6-
#### How to add
7-
8-
1. Locate the missing octicon `.svg` in [primer/octions](https://github.com/primer/octicons/tree/master/lib/svg) and download it to your local `app/assets/images/octions` folder
9-
1. Add a line to `app/assets/stylesheets/shared/_octicons.scss` for the new octicon, like so:
10-
```apple css
11-
.octicon-<YOUR OCTICON NAME>:before {
12-
content: url("#{$new-octicons-path}/<YOUR OCTICON FILENAME>.svg")
13-
}
14-
```
15-
16-
You may now use the new octicon in your content as normal! :tada:

content/github/creating-cloning-and-archiving-repositories/https-cloning-errors.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -46,16 +46,16 @@ typing `git remote -v`:
4646
```shell
4747
$ git remote -v
4848
# View existing remotes
49-
> origin https://github.com/github/reactivecocoa.git (fetch)
50-
> origin https://github.com/github/reactivecocoa.git (push)
49+
> origin https://github.com/ghost/reactivecocoa.git (fetch)
50+
> origin https://github.com/ghost/reactivecocoa.git (push)
5151

52-
$ git remote set-url origin https://github.com/github/ReactiveCocoa.git
52+
$ git remote set-url origin https://github.com/ghost/ReactiveCocoa.git
5353
# Change the 'origin' remote's URL
5454

5555
$ git remote -v
5656
# Verify new remote URL
57-
> origin https://github.com/github/ReactiveCocoa.git (fetch)
58-
> origin https://github.com/github/ReactiveCocoa.git (push)
57+
> origin https://github.com/ghost/ReactiveCocoa.git (fetch)
58+
> origin https://github.com/ghost/ReactiveCocoa.git (push)
5959
```
6060
6161
Alternatively, you can change the URL through our
@@ -73,7 +73,7 @@ When prompted for a username and password, make sure you use an account that has
7373
7474
{% tip %}
7575
76-
**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/using-git/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail.
76+
**Tip**: If you don't want to enter your credentials every time you interact with the remote repository, you can turn on [credential caching](/github/using-git/caching-your-github-credentials-in-git). If you are already using credential caching, please make sure that your computer has the correct credentials cached. Incorrect or out of date credentials will cause authentication to fail.
7777
7878
{% endtip %}
7979

content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ Scanning code when someone pushes a change, and whenever a pull request is creat
4444

4545
#### Scanning on push
4646

47-
By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)."
47+
By default, the {% data variables.product.prodname_codeql_workflow %} uses the `on.push` event to trigger a code scan on every push to the default branch of the repository and any protected branches. For {% data variables.product.prodname_code_scanning %} to be triggered on a specified branch, the workflow must exist in that branch. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#on)."
4848

4949
#### Scanning pull requests
5050

51-
The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% if currentVersion ver_gt "enterprise-server@2.21" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %}
51+
The default {% data variables.product.prodname_codeql_workflow %} uses the `pull_request` event to trigger a code scan on pull requests targeted against the default branch. {% if currentVersion ver_gt "enterprise-server@2.21" %}The `pull_request` event is not triggered if the pull request was opened from a private fork.{% else %}If a pull request is from a private fork, the `pull_request` event will only be triggered if you've selected the "Run workflows from fork pull requests" option in the repository settings. For more information, see "[Disabling or limiting {% data variables.product.prodname_actions %} for a repository](/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository#enabling-workflows-for-private-repository-forks)."{% endif %}
5252

5353
For more information about the `pull_request` event, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestbranchestags)."
5454

@@ -148,14 +148,14 @@ jobs:
148148
matrix:
149149
language: ['javascript', 'python']
150150
```
151-
151+
152152
If your workflow does not contain a matrix called `language`, then {% data variables.product.prodname_codeql %} is configured to run analysis sequentially. If you don't specify languages in the workflow, {% data variables.product.prodname_codeql %} automatically detects, and attempts to analyze, any supported languages in the repository. If you want to choose which languages to analyze, without using a matrix, you can use the `languages` parameter under the `init` action.
153153

154154
```yaml
155155
- uses: github/codeql-action/init@v1
156156
with:
157157
languages: cpp, csharp, python
158-
```
158+
```
159159
{% if currentVersion == "free-pro-team@latest" %}
160160
### Analyzing Python dependencies
161161

@@ -183,7 +183,7 @@ jobs:
183183
- name: Install dependencies
184184
run: |
185185
python -m pip install --upgrade pip
186-
if [ -f requirements.txt ];
186+
if [ -f requirements.txt ];
187187
then pip install -r requirements.txt;
188188
fi
189189
# Set the `CODEQL-PYTHON` environment variable to the Python executable
@@ -193,10 +193,10 @@ jobs:
193193
uses: github/codeql-action/init@v1
194194
with:
195195
languages: python
196-
# Override the default behavior so that the action doesn't attempt
196+
# Override the default behavior so that the action doesn't attempt
197197
# to auto-install Python dependencies
198198
setup-python-dependencies: false
199-
```
199+
```
200200
{% endif %}
201201
202202
### Running additional queries
@@ -239,7 +239,7 @@ In the workflow file, use the `config-file` parameter of the `init` action to sp
239239
```
240240

241241
The configuration file can be located within the local repository, or in a public, remote repository. For remote repositories, you can use the _owner/repository/file.yml@branch_ syntax. The settings in the file are written in YAML format.
242-
242+
243243
#### Specifying additional queries
244244

245245
You specify additional queries in a `queries` array. Each element of the array contains a `uses` parameter with a value that identifies a single query file, a directory containing query files, or a query suite definition file.
@@ -265,15 +265,15 @@ For the interpreted languages that {% data variables.product.prodname_codeql %}
265265

266266
``` yaml
267267
paths:
268-
- src
269-
paths-ignore:
268+
- src
269+
paths-ignore:
270270
- src/node_modules
271271
- '**/*.test.js'
272272
```
273273

274274
{% note %}
275275

276-
**Note**:
276+
**Note**:
277277

278278
* The `paths` and `paths-ignore` keywords, used in the context of the {% data variables.product.prodname_code_scanning %} configuration file, should not be confused with the same keywords when used for `on.<push|pull_request>.paths` in a workflow. When they are used to modify `on.<push|pull_request>` in a workflow, they determine whether the actions will be run when someone modifies code in the specified directories. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/reference/workflow-syntax-for-github-actions#onpushpull_requestpaths)."
279279
* `**` characters can only be at the start or end of a line, or surrounded by slashes, and you can't mix `**` and other characters. For example, `foo/**`, `**/foo`, and `foo/**/bar` are all allowed syntax, but `**foo` isn't. However you can use single stars along with other characters, as shown in the example. You'll need to quote anything that contains a `*` character.
@@ -298,7 +298,7 @@ You can quickly analyze small portions of a monorepo when you modify code in spe
298298

299299
If your workflow for {% data variables.product.prodname_code_scanning %} accesses a private repository, other than the repository that contains the workflow, you'll need to configure Git to authenticate with a personal access token. Define the secret in the runner environment by using `jobs.<job_id>.steps.env` in your workflow before any {% data variables.product.prodname_codeql %} actions. For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)" and "[Creating and storing encrypted secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)."
300300

301-
For example, the following configuration has Git replace the full URLs to the `github/foo`, `github/bar`, and `github/baz` repositories on {% data variables.product.prodname_dotcom_the_website %} with URLs that include the personal access token that you store in the `ACCESS_TOKEN` environment variable.
301+
For example, the following configuration has Git replace the full URLs to the `ghost/foo`, `ghost/bar`, and `ghost/baz` repositories on {% data variables.product.prodname_dotcom_the_website %} with URLs that include the personal access token that you store in the `ACCESS_TOKEN` environment variable.
302302

303303
{% raw %}
304304
```yaml
@@ -307,9 +307,9 @@ steps:
307307
env:
308308
TOKEN: ${{ secrets.ACCESS_TOKEN }}
309309
run: |
310-
git config --global url."https://${TOKEN}@github.com/github/foo".insteadOf "https://github.com/github/foo"
311-
git config --global url."https://${TOKEN}@github.com/github/bar".insteadOf "https://github.com/github/bar"
312-
git config --global url."https://${TOKEN}@github.com/github/baz".insteadOf "https://github.com/github/baz"
310+
git config --global url."https://${TOKEN}@github.com/ghost/foo".insteadOf "https://github.com/ghost/foo"
311+
git config --global url."https://${TOKEN}@github.com/ghost/bar".insteadOf "https://github.com/ghost/bar"
312+
git config --global url."https://${TOKEN}@github.com/ghost/baz".insteadOf "https://github.com/ghost/baz"
313313
```
314314
{% endraw %}
315315

0 commit comments

Comments
 (0)