Skip to content

Commit f0de842

Browse files
authored
Merge branch 'main' into patch-1
2 parents aaca067 + b0f9200 commit f0de842

File tree

619 files changed

+11923
-2638
lines changed

Some content is hidden

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

619 files changed

+11923
-2638
lines changed

.env.example

Lines changed: 0 additions & 3 deletions
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/CODEOWNERS

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ package.json @github/docs-engineering
2020
# Site Policy
2121
/content/github/site-policy/ @github/site-policy-admins
2222

23+
# Content strategy
24+
/contributing/content-markup-reference.md @github/product-docs-content-strategy
25+
/contributing/content-style-guide.md @github/product-docs-content-strategy
26+
2327
# Make sure that Octokit maintainers get notified about changes
2428
# relevant to the Octokit libraries (https://github.com/octokit)
2529
/content/rest/reference @github/octokit-maintainers

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

Lines changed: 2 additions & 2 deletions
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

Lines changed: 2 additions & 2 deletions
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

.github/allowed-actions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ module.exports = [
3030
'rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e',
3131
'repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88',
3232
'repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d',
33-
'rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815',
33+
'someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd',
3434
'tjenkinson/gh-action-auto-merge-dependency-updates@cee2ac0',
3535
'EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575'
3636
]
Lines changed: 39 additions & 0 deletions
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+
})
Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Confirm internal staff meant to post in public
2+
3+
on:
4+
issues:
5+
types:
6+
- opened
7+
- reopened
8+
- transferred
9+
pull_request_target:
10+
types:
11+
- opened
12+
- reopened
13+
14+
jobs:
15+
check-team-membership:
16+
runs-on: ubuntu-latest
17+
continue-on-error: true
18+
if: github.repository == 'github/docs'
19+
steps:
20+
- id: membership_check
21+
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
22+
with:
23+
github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
24+
script: |
25+
// Only perform this action with GitHub employees
26+
try {
27+
await github.teams.getMembershipForUserInOrg({
28+
org: 'github',
29+
team_slug: 'employees',
30+
username: context.payload.sender.login,
31+
});
32+
} catch(err) {
33+
// An error will be thrown if the user is not a GitHub employee
34+
// If a user is not a GitHub employee, we should stop here and
35+
// Not send a notification
36+
return
37+
}
38+
39+
// Don't perform this action with Docs team members
40+
try {
41+
await github.teams.getMembershipForUserInOrg({
42+
org: 'github',
43+
team_slug: 'docs',
44+
username: context.payload.sender.login,
45+
});
46+
// If the user is a Docs team member, we should stop here and not send
47+
// a notification
48+
return
49+
} catch(err) {
50+
// An error will be thrown if the user is not a Docs team member
51+
// If a user is not a Docs team member we should continue and send
52+
// the notification
53+
}
54+
55+
const issueNo = context.number || context.issue.number
56+
57+
// Create an issue in our private repo
58+
await github.issues.create({
59+
owner: 'github',
60+
repo: 'docs-internal',
61+
title: `@${context.payload.sender.login} confirm that \#${issueNo} should be in the public github/docs repo`,
62+
body: `@${context.payload.sender.login} opened https://github.com/github/docs/issues/${issueNo} publicly in the github/docs repo, instead of the private github/docs-internal repo.\n\n@${context.payload.sender.login}, please confirm that this belongs in the public repo and that no sensitive information was disclosed by commenting below and closing the issue.\n\nIf this was not intentional and sensitive information was shared, please delete https://github.com/github/docs/issues/${issueNo} and notify us in the \#docs-open-source channel.\n\nThanks! \n\n/cc @github/docs @github/docs-engineering`
63+
});
64+
65+
core.setOutput('did_warn', 'true')
66+
67+
- name: Send Slack notification if a GitHub employee who isn't on the docs team opens an issue in public
68+
if: ${{ steps.membership_check.outputs.did_warn && github.repository == 'github/docs' }}
69+
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
70+
with:
71+
channel: ${{ secrets.DOCS_OPEN_SOURCE_SLACK_CHANNEL_ID }}
72+
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
73+
text: <@${{github.actor}}> opened https://github.com/github/docs/issues/${{ github.event.number || github.event.issue.number }} publicly on the github/docs repo instead of the private github/docs-internal repo. They have been notified via a new issue in the github/docs-internal repo to confirm this was intentional.

.github/workflows/js-lint.yml

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,23 +10,8 @@ on:
1010
- translations
1111

1212
jobs:
13-
see_if_should_skip:
14-
runs-on: ubuntu-latest
15-
16-
outputs:
17-
should_skip: ${{ steps.skip_check.outputs.should_skip }}
18-
steps:
19-
- id: skip_check
20-
uses: fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289
21-
with:
22-
cancel_others: 'false'
23-
github_token: ${{ github.token }}
24-
paths: '["**/*.js", "package*.json", ".github/workflows/js-lint.yml", ".eslint*"]'
25-
2613
lint:
2714
runs-on: ubuntu-latest
28-
needs: see_if_should_skip
29-
if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
3015
steps:
3116
- name: Check out repo
3217
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f

.github/workflows/repo-freeze-reminders.yml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,10 @@ jobs:
1414
if: github.repository == 'github/docs-internal'
1515
steps:
1616
- name: Send Slack notification if repo is frozen
17+
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
1718
if: ${{ env.FREEZE == 'true' }}
18-
uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815
19-
env:
20-
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
21-
SLACK_USERNAME: docs-repo-sync
22-
SLACK_ICON_EMOJI: ':freezing_face:'
23-
SLACK_COLOR: '#51A0D5' # Carolina Blue
24-
SLACK_MESSAGE: All repo-sync runs will fail for ${{ github.repository }} because the repo is currently frozen!
19+
with:
20+
channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
21+
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
22+
color: info
23+
text: All repo-sync runs will fail for ${{ github.repository }} because the repo is currently frozen!
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Repo Sync Stalls
2+
on:
3+
workflow_dispatch:
4+
schedule:
5+
- cron: '0 */2 * * *'
6+
jobs:
7+
check-freezer:
8+
name: Check for deployment freezes
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Exit if repo is frozen
12+
if: ${{ env.FREEZE == 'true' }}
13+
run: |
14+
echo 'The repo is currently frozen! Exiting this workflow.'
15+
exit 1 # prevents further steps from running
16+
repo-sync-stalls:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Check if repo sync is stalled
20+
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
21+
with:
22+
github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
23+
script: |
24+
let pulls;
25+
const owner = context.repo.owner
26+
const repo = context.repo.repo
27+
try {
28+
pulls = await github.pulls.list({
29+
owner: owner,
30+
repo: repo,
31+
head: `${owner}:repo-sync`,
32+
state: 'open'
33+
});
34+
} catch(err) {
35+
throw err
36+
return
37+
}
38+
39+
pulls.data.forEach(pr => {
40+
const timeDelta = Date.now() - Date.parse(pr.created_at);
41+
const minutesOpen = timeDelta / 1000 / 60;
42+
43+
if (minutesOpen > 30) {
44+
core.setFailed('Repo sync appears to be stalled')
45+
}
46+
})
47+
- name: Send Slack notification if workflow fails
48+
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
49+
if: failure()
50+
with:
51+
channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
52+
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
53+
color: failure
54+
text: Repo sync appears to be stalled for ${{github.repository}}. See https://github.com/${{github.repository}}/pulls?q=is%3Apr+is%3Aopen+repo+sync

0 commit comments

Comments
 (0)