Skip to content

Commit 6db9593

Browse files
authored
Merge branch 'main' into update-eol-date-for-2.20
2 parents cec46e6 + b6019bc commit 6db9593

File tree

61 files changed

+1571
-240
lines changed

Some content is hidden

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

61 files changed

+1571
-240
lines changed

.devcontainer.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,12 @@
22
// For format details, see https://aka.ms/vscode-remote/devcontainer.json
33
{
44
"name": "docs.github.com",
5-
"service": "container-doc",
65
"settings": {
76
"terminal.integrated.shell.linux": "/bin/bash",
87
"cSpell.language": ",en"
98
},
10-
// Install pre-requisites, and start to serve docs.github.com locally
11-
"postCreateCommand": "npm install && npm start",
9+
// Install pre-requisites and run a build to ensure we are ready to start serving docs.github.com locally (via `npm start`)
10+
"postCreateCommand": "npm ci && npm run build",
1211
"forwardPorts": [4000],
1312
// Visual Studio Code extensions which help authoring for docs.github.com.
1413
"extensions": [
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Change production configuration
3+
about: Track changes to the production docs.github.com site
4+
title: ''
5+
labels: engineering
6+
assignees: ''
7+
---
8+
9+
A configuration change would be something outside of our code that we change with our production environment, such as environment variables, virtual machine tier or quantity, or service providers.
10+
11+
- _Primary person_:
12+
- _Second person_:
13+
- _When_:
14+
- _Zoom URL_:
15+
16+
### What is the configuration change?
17+
18+
### Why are we updating this configuration?
19+
20+
### What risks are there with this configuration change?
21+
22+
### If an issue happens, how do we roll back?
23+
24+
Once the change is verified good, please close this issue.

.github/allowed-actions.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ module.exports = [
1111
"actions/setup-node@c46424eee26de4078d34105d3de3cc4992202b1e", //actions/[email protected]
1212
"ruby/setup-ruby@fdcfbcf14ec9672f6f615cb9589a1bc5dd69d262", //ruby/[email protected]
1313
"actions/stale@9d6f46564a515a9ea11e7762ab3957ee58ca50da", //actions/stale@v3.0.16
14+
"alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9",
15+
"andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84",
1416
"archive/github-actions-slack@d368c5a4ad757515a9344918f84c490b05777d94",
1517
"ashley-taylor/regex-property-action@93a24f845cd20790924208225cc72da8b4c6d46d",
1618
"crowdin/github-action@fd9429dd63d6c0f8a8cb4b93ad8076990bd6e688",

.github/workflows/autoupdate-branch.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ on:
1717
push:
1818
branches:
1919
- main
20-
schedule:
21-
- cron: '*/30 * * * *' # every 30 minutes
2220

2321
jobs:
2422
autoupdate:
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Move help wanted issues
2+
on:
3+
issues:
4+
types:
5+
- labeled
6+
7+
jobs:
8+
move_issues:
9+
if: github.repository == 'github/docs' && (github.event.label.name == 'help wanted' || github.event.label.name == 'good first issue')
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9
14+
with:
15+
project: Docs team reviews
16+
column: Help wanted
17+
repo-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Move and unlabel ready to merge issues
2+
on:
3+
issues:
4+
types:
5+
- labeled
6+
7+
jobs:
8+
unmark_for_review:
9+
if: github.repository == 'github/docs' && github.event.label.name == 'ready to merge'
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: move issue
13+
uses: alex-page/github-project-automation-plus@fdb7991b72040d611e1123d2b75ff10eda9372c9
14+
with:
15+
project: Docs team reviews
16+
column: Triage
17+
repo-token: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }}
18+
- name: remove label
19+
uses: andymckay/labeler@22d5392de2b725cea4b284df5824125054049d84
20+
with:
21+
remove-labels: 'waiting for review'
22+
repo-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/repo-sync.yml

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ jobs:
4040
destination_branch: main
4141
pr_title: 'repo sync'
4242
pr_body: "This is an automated pull request to sync changes between the public and private repos.\n\n:robot: This pull request should be merged (not squashed) to preserve continuity across repos, so please let a bot do the merging!"
43-
pr_label: autoupdate,automated-reposync-pr
43+
pr_label: automerge,autoupdate,automated-reposync-pr
4444
github_token: ${{ secrets.OCTOMERGER_PAT_WITH_REPO_AND_WORKFLOW_SCOPE }}
4545

4646
- name: Find pull request
@@ -88,32 +88,6 @@ jobs:
8888
console.log(`Branch is already up-to-date`)
8989
}
9090
91-
- name: Enable GitHub auto-merge
92-
if: ${{ steps.find-pull-request.outputs.number }}
93-
uses: actions/github-script@626af12fe9a53dc2972b48385e7fe7dec79145c9
94-
with:
95-
github-token: ${{ secrets.GITHUB_TOKEN }}
96-
script: |
97-
const pull = await github.pulls.get({
98-
...context.repo,
99-
pull_number: parseInt(${{ steps.find-pull-request.outputs.number }})
100-
})
101-
102-
const pullNodeId = pull.data.node_id
103-
console.log(`Pull request GraphQL Node ID: ${pullNodeId}`)
104-
105-
const mutation = `mutation ($id: ID!) {
106-
enablePullRequestAutoMerge(input: {
107-
pullRequestId: $id,
108-
mergeMethod: MERGE
109-
})
110-
}`
111-
const variables = {
112-
id: pullNodeId
113-
}
114-
await github.graphql(mutation, variables)
115-
console.log('Auto-merge enabled!')
116-
11791
- name: Send Slack notification if workflow fails
11892
uses: someimportantcompany/github-actions-slack-message@0b470c14b39da4260ed9e3f9a4f1298a74ccdefd
11993
if: failure()

content/admin/enterprise-management/upgrading-github-enterprise-server.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ Increased requirements for {% data variables.product.prodname_ghe_server %} 3.0
4545
| 5,000 to 8000 | **16**<br/>_Up from 12_ | 96 GB | 750 GB | 200 GB |
4646
| 8,000 to 10,000+ | **20**<br/>_Up from 16_ | **160 GB**<br/>_Up from 128 GB_ | 1000 GB | 200 GB |
4747

48+
For more information about hardware requirements for {% data variables.product.prodname_actions %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.prodname_ghe_server %}](/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server#review-hardware-considerations)."
49+
4850
{% data reusables.enterprise_installation.about-adjusting-resources %}
4951

5052
{% endif %}

content/admin/github-actions/getting-started-with-github-actions-for-github-enterprise-server.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,20 @@ This article explains how site administrators can configure {% data variables.pr
3131

3232
{% endif %}
3333

34-
{% data reusables.actions.enterprise-hardware-considerations %}
34+
The CPU and memory resources available to {% data variables.product.product_location %} determine the maximum job throughput for {% data variables.product.prodname_actions %}.
3535

36-
For more information about resource requirements for {% data variables.product.prodname_ghe_server %}, see the hardware considerations for your instance's platform.
36+
Internal testing at {% data variables.product.company_short %} demonstrated the following maximum throughput for {% data variables.product.prodname_ghe_server %} instances with a range of CPU and memory configurations. You may see different throughput depending on the overall levels of activity on your instance.
37+
38+
| vCPUs | Memory | Maximum job throughput |
39+
| :--- | :--- | :--- |
40+
| 4 | 32 GB | Demo or light testing |
41+
| 8 | 64 GB | 25 jobs |
42+
| 16 | 160 GB | 35 jobs |
43+
| 32 | 256 GB | 100 jobs |
44+
45+
If you {% if currentVersion == "[email protected]" %}enabled the beta of{% else %}plan to enable{% endif %} {% data variables.product.prodname_actions %} for the users of an existing instance, review the levels of activity for users and automations on the instance and ensure that you have provisioned adequate CPU and memory for your users. For more information about monitoring the capacity and performance of {% data variables.product.prodname_ghe_server %}, see "[Monitoring your appliance](/admin/enterprise-management/monitoring-your-appliance)."
46+
47+
For more information about minimum hardware requirements for {% data variables.product.product_location %}, see the hardware considerations for your instance's platform.
3748

3849
- [AWS](/admin/installation/installing-github-enterprise-server-on-aws#hardware-considerations)
3950
- [Azure](/admin/installation/installing-github-enterprise-server-on-azure#hardware-considerations)

content/developers/apps/setting-permissions-for-github-apps.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,4 @@ versions:
1111
github-ae: '*'
1212
---
1313

14-
When you create a GitHub App, you can select the permissions it needs to access end user data. Permissions can also be added and removed. For more information, see "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)."
15-
16-
### Metadata permissions
17-
18-
By default, GitHub Apps have `Read-only` access to metadata endpoints. Metadata is a collection of read-only endpoints that provide general information about resources that the authorized installation can access.
19-
20-
{% data reusables.apps.metadata-permissions %} For a list of metadata endpoints, see "[Metadata permissions](/rest/reference/permissions-required-for-github-apps#metadata-permissions)."
14+
GitHub Apps don't have any permissions by default. When you create a GitHub App, you can select the permissions it needs to access end user data. Permissions can also be added and removed. For more information, see "[Editing a GitHub App's permissions](/apps/managing-github-apps/editing-a-github-app-s-permissions/)."

0 commit comments

Comments
 (0)