Merge branch 'main' of github.com:github/docs-internal into list-of-deprecated-versions
2
.github/allowed-actions.js
vendored
@@ -30,7 +30,7 @@ module.exports = [
|
||||
'rachmari/labeler@832d42ec5523f3c6d46e8168de71cd54363e3e2e',
|
||||
'repo-sync/github-sync@3832fe8e2be32372e1b3970bbae8e7079edeec88',
|
||||
'repo-sync/pull-request@33777245b1aace1a58c87a29c90321aa7a74bd7d',
|
||||
'rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815',
|
||||
'someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd',
|
||||
'tjenkinson/gh-action-auto-merge-dependency-updates@cee2ac0',
|
||||
'EndBug/add-and-commit@9358097a71ad9fb9e2f9624c6098c89193d83575'
|
||||
]
|
||||
|
||||
72
.github/workflows/confirm-internal-staff-work-in-docs.yml
vendored
Normal file
@@ -0,0 +1,72 @@
|
||||
name: Confirm internal staff meant to post in public
|
||||
|
||||
on:
|
||||
issues:
|
||||
types:
|
||||
- opened
|
||||
- reopened
|
||||
- transferred
|
||||
pull_request_target:
|
||||
types:
|
||||
- opened
|
||||
- reopened
|
||||
|
||||
jobs:
|
||||
check-team-membership:
|
||||
runs-on: ubuntu-latest
|
||||
continue-on-error: true
|
||||
if: github.repository == 'github/docs'
|
||||
steps:
|
||||
- uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
|
||||
with:
|
||||
github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
|
||||
script: |
|
||||
// Only perform this action with GitHub employees
|
||||
try {
|
||||
await github.teams.getMembershipForUserInOrg({
|
||||
org: 'github',
|
||||
team_slug: 'employees',
|
||||
username: context.payload.sender.login,
|
||||
});
|
||||
} catch(err) {
|
||||
// An error will be thrown if the user is not a GitHub employee
|
||||
// If a user is not a GitHub employee, we should stop here and
|
||||
// Not send a notification
|
||||
return
|
||||
}
|
||||
|
||||
// Don't perform this action with Docs team members
|
||||
try {
|
||||
await github.teams.getMembershipForUserInOrg({
|
||||
org: 'github',
|
||||
team_slug: 'docs',
|
||||
username: context.payload.sender.login,
|
||||
});
|
||||
// If the user is a Docs team member, we should stop here and not send
|
||||
// a notification
|
||||
return
|
||||
} catch(err) {
|
||||
// An error will be thrown if the user is not a Docs team member
|
||||
// If a user is not a Docs team member we should continue and send
|
||||
// the notification
|
||||
}
|
||||
|
||||
const issueNo = context.number || context.issue.number
|
||||
|
||||
// Create an issue in our private repo
|
||||
await github.issues.create({
|
||||
owner: 'github',
|
||||
repo: 'docs-internal',
|
||||
title: `@${context.payload.sender.login} confirm that \#${issueNo} should be in the public github/docs repo`,
|
||||
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`
|
||||
});
|
||||
|
||||
throw new Error('A Hubber opened an issue on the public github/docs repo');
|
||||
|
||||
- name: Send Slack notification if a GitHub employee who isn't on the docs team opens an issue in public
|
||||
if: ${{ failure() && github.repository == 'github/docs' }}
|
||||
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
|
||||
with:
|
||||
channel: ${{ secrets.DOCS_OPEN_SOURCE_SLACK_CHANNEL_ID }}
|
||||
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
|
||||
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.
|
||||
15
.github/workflows/js-lint.yml
vendored
@@ -10,23 +10,8 @@ on:
|
||||
- translations
|
||||
|
||||
jobs:
|
||||
see_if_should_skip:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
outputs:
|
||||
should_skip: ${{ steps.skip_check.outputs.should_skip }}
|
||||
steps:
|
||||
- id: skip_check
|
||||
uses: fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289
|
||||
with:
|
||||
cancel_others: 'false'
|
||||
github_token: ${{ github.token }}
|
||||
paths: '["**/*.js", "package*.json", ".github/workflows/js-lint.yml", ".eslint*"]'
|
||||
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
needs: see_if_should_skip
|
||||
if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
steps:
|
||||
- name: Check out repo
|
||||
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
|
||||
|
||||
13
.github/workflows/repo-freeze-reminders.yml
vendored
@@ -14,11 +14,10 @@ jobs:
|
||||
if: github.repository == 'github/docs-internal'
|
||||
steps:
|
||||
- name: Send Slack notification if repo is frozen
|
||||
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
|
||||
if: ${{ env.FREEZE == 'true' }}
|
||||
uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815
|
||||
env:
|
||||
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
|
||||
SLACK_USERNAME: docs-repo-sync
|
||||
SLACK_ICON_EMOJI: ':freezing_face:'
|
||||
SLACK_COLOR: '#51A0D5' # Carolina Blue
|
||||
SLACK_MESSAGE: All repo-sync runs will fail for ${{ github.repository }} because the repo is currently frozen!
|
||||
with:
|
||||
channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
|
||||
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
|
||||
color: info
|
||||
text: All repo-sync runs will fail for ${{ github.repository }} because the repo is currently frozen!
|
||||
|
||||
54
.github/workflows/repo-sync-stalls.yml
vendored
Normal file
@@ -0,0 +1,54 @@
|
||||
name: Repo Sync Stalls
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '*/30 * * * *'
|
||||
jobs:
|
||||
check-freezer:
|
||||
name: Check for deployment freezes
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Exit if repo is frozen
|
||||
if: ${{ env.FREEZE == 'true' }}
|
||||
run: |
|
||||
echo 'The repo is currently frozen! Exiting this workflow.'
|
||||
exit 1 # prevents further steps from running
|
||||
repo-sync-stalls:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Check if repo sync is stalled
|
||||
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
|
||||
with:
|
||||
github-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
|
||||
script: |
|
||||
let pulls;
|
||||
const owner = context.repo.owner
|
||||
const repo = context.repo.repo
|
||||
try {
|
||||
pulls = await github.pulls.list({
|
||||
owner: owner,
|
||||
repo: repo,
|
||||
head: `${owner}:repo-sync`,
|
||||
state: 'open'
|
||||
});
|
||||
} catch(err) {
|
||||
throw err
|
||||
return
|
||||
}
|
||||
|
||||
pulls.data.forEach(pr => {
|
||||
const timeDelta = Date.now() - Date.parse(pr.created_at);
|
||||
const minutesOpen = timeDelta / 1000 / 60;
|
||||
|
||||
if (minutesOpen > 30) {
|
||||
core.setFailed('Repo sync appears to be stalled')
|
||||
}
|
||||
})
|
||||
- name: Send Slack notification if workflow fails
|
||||
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
|
||||
if: failure()
|
||||
with:
|
||||
channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
|
||||
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
|
||||
color: failure
|
||||
text: Repo sync appears to be stalled for ${{github.repository}}. See https://github.com/${{github.repository}}/pulls?q=is%3Apr+is%3Aopen+repo+sync
|
||||
16
.github/workflows/repo-sync.yml
vendored
@@ -7,6 +7,7 @@
|
||||
name: Repo Sync
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
schedule:
|
||||
- cron: '*/15 * * * *' # every 15 minutes
|
||||
|
||||
@@ -70,11 +71,10 @@ jobs:
|
||||
number: ${{ steps.find-pull-request.outputs.number }}
|
||||
|
||||
- name: Send Slack notification if workflow fails
|
||||
uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815
|
||||
if: ${{ failure() }}
|
||||
env:
|
||||
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
|
||||
SLACK_USERNAME: docs-repo-sync
|
||||
SLACK_ICON_EMOJI: ':ohno:'
|
||||
SLACK_COLOR: '#B90E0A' # Crimson
|
||||
SLACK_MESSAGE: The last repo-sync run for ${{github.repository}} failed. See https://github.com/${{github.repository}}/actions?query=workflow%3A%22Repo+Sync%22
|
||||
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
|
||||
if: failure()
|
||||
with:
|
||||
channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
|
||||
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
|
||||
color: failure
|
||||
text: The last repo-sync run for ${{github.repository}} failed. See https://github.com/${{github.repository}}/actions?query=workflow%3A%22Repo+Sync%22
|
||||
|
||||
@@ -33,8 +33,10 @@ jobs:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: npm run sync-search
|
||||
- name: Send slack notification if workflow run fails
|
||||
uses: rtCamp/action-slack-notify@e17352feaf9aee300bf0ebc1dfbf467d80438815
|
||||
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
|
||||
if: failure()
|
||||
env:
|
||||
SLACK_WEBHOOK: ${{ secrets.DOCS_ALERTS_SLACK_WEBHOOK }}
|
||||
SLACK_MESSAGE: The last Algolia workflow run for ${{github.repository}} failed. Search actions for `workflow:Algolia`
|
||||
with:
|
||||
channel: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
|
||||
bot-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
|
||||
color: failure
|
||||
text: The last Algolia workflow run for ${{github.repository}} failed. Search actions for `workflow:Algolia`
|
||||
|
||||
15
.github/workflows/yml-lint.yml
vendored
@@ -10,23 +10,8 @@ on:
|
||||
- translations
|
||||
|
||||
jobs:
|
||||
see_if_should_skip:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
outputs:
|
||||
should_skip: ${{ steps.skip_check.outputs.should_skip }}
|
||||
steps:
|
||||
- id: skip_check
|
||||
uses: fkirc/skip-duplicate-actions@36feb0d8d062137530c2e00bd278d138fe191289
|
||||
with:
|
||||
cancel_others: 'false'
|
||||
github_token: ${{ github.token }}
|
||||
paths: '["**/*.yml", "**/*.yaml", "package*.json", ".github/workflows/yml-lint.yml"]'
|
||||
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
needs: see_if_should_skip
|
||||
if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }}
|
||||
steps:
|
||||
- name: Check out repo
|
||||
uses: actions/checkout@5a4ac9002d0be2fb38bd78e4b4dbde5606d7042f
|
||||
|
||||
@@ -28,7 +28,7 @@ If you've found a problem, you can open an issue using a [template](https://gith
|
||||
|
||||
#### Solve an issue
|
||||
|
||||
If you have a solution to one of the open issues, you will need to fork the repository and submit a PR using the [template](https://github.com/github/docs/blob/main/CONTRIBUTING.md#pull-request-template) that is visible automatically in the pull request body. For more details about this process, please check out [Getting Started with Contributing](/CONTRIBUTING.md).
|
||||
If you have a solution to one of the open issues, you will need to fork the repository and submit a pull request using the [template](https://github.com/github/docs/blob/main/CONTRIBUTING.md#pull-request-template) that is visible automatically in the pull request body. For more details about this process, please check out [Getting Started with Contributing](/CONTRIBUTING.md).
|
||||
|
||||
#### Join us in discussions
|
||||
|
||||
|
||||
BIN
assets/images/help/classroom/assignment-group-hero.png
Normal file
|
After Width: | Height: | Size: 164 KiB |
|
After Width: | Height: | Size: 76 KiB |
BIN
assets/images/help/classroom/assignment-individual-hero.png
Normal file
|
After Width: | Height: | Size: 175 KiB |
|
After Width: | Height: | Size: 28 KiB |
BIN
assets/images/help/classroom/assignments-assign-deadline.png
Normal file
|
After Width: | Height: | Size: 83 KiB |
BIN
assets/images/help/classroom/assignments-assignment-title.png
Normal file
|
After Width: | Height: | Size: 32 KiB |
|
After Width: | Height: | Size: 28 KiB |
|
After Width: | Height: | Size: 72 KiB |
|
After Width: | Height: | Size: 20 KiB |
|
After Width: | Height: | Size: 24 KiB |
|
After Width: | Height: | Size: 76 KiB |
|
After Width: | Height: | Size: 53 KiB |
BIN
assets/images/help/classroom/assignments-click-online-ide.png
Normal file
|
After Width: | Height: | Size: 134 KiB |
BIN
assets/images/help/classroom/assignments-click-pencil.png
Normal file
|
After Width: | Height: | Size: 78 KiB |
BIN
assets/images/help/classroom/assignments-click-review-button.png
Normal file
|
After Width: | Height: | Size: 19 KiB |
|
After Width: | Height: | Size: 21 KiB |
|
After Width: | Height: | Size: 121 KiB |
|
After Width: | Height: | Size: 21 KiB |
BIN
assets/images/help/classroom/assignments-click-view-ide.png
Normal file
|
After Width: | Height: | Size: 77 KiB |
BIN
assets/images/help/classroom/assignments-click-view-test.png
Normal file
|
After Width: | Height: | Size: 96 KiB |
BIN
assets/images/help/classroom/assignments-define-teams.png
Normal file
|
After Width: | Height: | Size: 71 KiB |
|
After Width: | Height: | Size: 39 KiB |
|
After Width: | Height: | Size: 40 KiB |
BIN
assets/images/help/classroom/autograding-actions-logs.png
Normal file
|
After Width: | Height: | Size: 330 KiB |
BIN
assets/images/help/classroom/autograding-actions-tab.png
Normal file
|
After Width: | Height: | Size: 187 KiB |
|
After Width: | Height: | Size: 95 KiB |
BIN
assets/images/help/classroom/autograding-click-pencil.png
Normal file
|
After Width: | Height: | Size: 58 KiB |
BIN
assets/images/help/classroom/autograding-click-trash.png
Normal file
|
After Width: | Height: | Size: 58 KiB |
BIN
assets/images/help/classroom/autograding-hero.png
Normal file
|
After Width: | Height: | Size: 168 KiB |
|
After Width: | Height: | Size: 154 KiB |
BIN
assets/images/help/classroom/classroom-copy-credentials.png
Normal file
|
After Width: | Height: | Size: 166 KiB |
BIN
assets/images/help/classroom/classroom-hero.png
Normal file
|
After Width: | Height: | Size: 181 KiB |
|
After Width: | Height: | Size: 48 KiB |
|
After Width: | Height: | Size: 94 KiB |
BIN
assets/images/help/classroom/classroom-settings-click-lms.png
Normal file
|
After Width: | Height: | Size: 148 KiB |
BIN
assets/images/help/classroom/click-assignment-in-list.png
Normal file
|
After Width: | Height: | Size: 149 KiB |
BIN
assets/images/help/classroom/click-classroom-in-list.png
Normal file
|
After Width: | Height: | Size: 52 KiB |
BIN
assets/images/help/classroom/click-create-classroom-button.png
Normal file
|
After Width: | Height: | Size: 50 KiB |
BIN
assets/images/help/classroom/click-create-roster-button.png
Normal file
|
After Width: | Height: | Size: 30 KiB |
BIN
assets/images/help/classroom/click-delete-classroom-button.png
Normal file
|
After Width: | Height: | Size: 78 KiB |
|
After Width: | Height: | Size: 61 KiB |
BIN
assets/images/help/classroom/click-new-classroom-button.png
Normal file
|
After Width: | Height: | Size: 52 KiB |
BIN
assets/images/help/classroom/click-organization.png
Normal file
|
After Width: | Height: | Size: 83 KiB |
BIN
assets/images/help/classroom/click-settings.png
Normal file
|
After Width: | Height: | Size: 28 KiB |
BIN
assets/images/help/classroom/click-students.png
Normal file
|
After Width: | Height: | Size: 30 KiB |
BIN
assets/images/help/classroom/click-update-students-button.png
Normal file
|
After Width: | Height: | Size: 60 KiB |
|
After Width: | Height: | Size: 127 KiB |
|
After Width: | Height: | Size: 104 KiB |
|
After Width: | Height: | Size: 264 KiB |
|
After Width: | Height: | Size: 69 KiB |
|
After Width: | Height: | Size: 234 KiB |
BIN
assets/images/help/classroom/probot-settings.gif
Normal file
|
After Width: | Height: | Size: 955 KiB |
BIN
assets/images/help/classroom/roster-hero.png
Normal file
|
After Width: | Height: | Size: 113 KiB |
|
After Width: | Height: | Size: 40 KiB |
BIN
assets/images/help/classroom/settings-type-classroom-name.png
Normal file
|
After Width: | Height: | Size: 41 KiB |
|
After Width: | Height: | Size: 140 KiB |
BIN
assets/images/help/classroom/setup-click-authorize-github.png
Normal file
|
After Width: | Height: | Size: 102 KiB |
BIN
assets/images/help/classroom/setup-click-grant.png
Normal file
|
After Width: | Height: | Size: 163 KiB |
|
After Width: | Height: | Size: 324 KiB |
|
After Width: | Height: | Size: 91 KiB |
BIN
assets/images/help/classroom/type-classroom-name.png
Normal file
|
After Width: | Height: | Size: 48 KiB |
|
After Width: | Height: | Size: 174 KiB |
|
After Width: | Height: | Size: 83 KiB |
|
After Width: | Height: | Size: 45 KiB |
BIN
assets/images/help/discussions/choose-new-category.png
Normal file
|
After Width: | Height: | Size: 55 KiB |
BIN
assets/images/help/discussions/click-delete-and-move-button.png
Normal file
|
After Width: | Height: | Size: 57 KiB |
BIN
assets/images/help/discussions/click-delete-discussion.png
Normal file
|
After Width: | Height: | Size: 60 KiB |
BIN
assets/images/help/discussions/click-delete-for-category.png
Normal file
|
After Width: | Height: | Size: 65 KiB |
|
After Width: | Height: | Size: 69 KiB |
BIN
assets/images/help/discussions/click-discussion-in-list.png
Normal file
|
After Width: | Height: | Size: 353 KiB |
BIN
assets/images/help/discussions/click-edit-categories.png
Normal file
|
After Width: | Height: | Size: 41 KiB |
BIN
assets/images/help/discussions/click-edit-for-category.png
Normal file
|
After Width: | Height: | Size: 64 KiB |
BIN
assets/images/help/discussions/click-edit-pinned-discussion.png
Normal file
|
After Width: | Height: | Size: 60 KiB |
BIN
assets/images/help/discussions/click-new-category-button.png
Normal file
|
After Width: | Height: | Size: 104 KiB |
BIN
assets/images/help/discussions/click-pin-discussion-button.png
Normal file
|
After Width: | Height: | Size: 98 KiB |
BIN
assets/images/help/discussions/click-pin-discussion.png
Normal file
|
After Width: | Height: | Size: 56 KiB |
BIN
assets/images/help/discussions/click-save.png
Normal file
|
After Width: | Height: | Size: 104 KiB |
|
After Width: | Height: | Size: 60 KiB |
BIN
assets/images/help/discussions/click-transfer-discussion.png
Normal file
|
After Width: | Height: | Size: 60 KiB |
BIN
assets/images/help/discussions/click-unpin-discussion-button.png
Normal file
|
After Width: | Height: | Size: 63 KiB |
BIN
assets/images/help/discussions/click-unpin-discussion.png
Normal file
|
After Width: | Height: | Size: 60 KiB |
BIN
assets/images/help/discussions/comment-mark-as-answer-button.png
Normal file
|
After Width: | Height: | Size: 140 KiB |
BIN
assets/images/help/discussions/comment-marked-as-answer.png
Normal file
|
After Width: | Height: | Size: 136 KiB |
BIN
assets/images/help/discussions/customize-pinned-discussion.png
Normal file
|
After Width: | Height: | Size: 234 KiB |
BIN
assets/images/help/discussions/discussons-hero.png
Normal file
|
After Width: | Height: | Size: 1.2 MiB |
BIN
assets/images/help/discussions/edit-category-details.png
Normal file
|
After Width: | Height: | Size: 139 KiB |
|
After Width: | Height: | Size: 136 KiB |
|
After Width: | Height: | Size: 56 KiB |
BIN
assets/images/help/discussions/hero.png
Normal file
|
After Width: | Height: | Size: 680 KiB |
BIN
assets/images/help/discussions/most-helpful.png
Normal file
|
After Width: | Height: | Size: 307 KiB |
|
After Width: | Height: | Size: 53 KiB |