Skip to content

Commit 0f507e3

Browse files
Merge branch 'main' into sheladiyadhaval-patch-1
2 parents 8a33288 + 16e53bb commit 0f507e3

File tree

237 files changed

+3216
-677
lines changed

Some content is hidden

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

237 files changed

+3216
-677
lines changed

.github/branch_protection_settings/main.json

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,10 @@
4141
"workflows",
4242
"lint-code",
4343
"secret-scanning",
44-
"pagelist"
44+
"pagelist",
45+
"docs-internal-docker-image / docs-internal-docker-image",
46+
"docs-internal-docker-security / docs-internal-docker-security",
47+
"docs-internal-moda-config-bundle / docs-internal-moda-config-bundle"
4548
],
4649
"contexts_url": "https://api.github.com/repos/github/docs-internal/branches/main/protection/required_status_checks/contexts",
4750
"checks": [
@@ -85,7 +88,19 @@
8588
{ "context": "workflows", "app_id": 15368 },
8689
{ "context": "lint-code", "app_id": 15368 },
8790
{ "context": "secret-scanning", "app_id": 15368 },
88-
{ "context": "pagelist", "app_id": 15368 }
91+
{ "context": "pagelist", "app_id": 15368 },
92+
{
93+
"context": "docs-internal-docker-image / docs-internal-docker-image",
94+
"app_id": 15368
95+
},
96+
{
97+
"context": "docs-internal-docker-security / docs-internal-docker-security",
98+
"app_id": 15368
99+
},
100+
{
101+
"context": "docs-internal-moda-config-bundle / docs-internal-moda-config-bundle",
102+
"app_id": 15368
103+
}
89104
]
90105
},
91106
"restrictions": {

.github/workflows/azure-prod-build-deploy.yml

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ name: Azure Production - Build and Deploy
55
# **Who does it impact**: All contributors.
66

77
on:
8-
push:
9-
branches:
10-
- main
118
workflow_dispatch:
129

1310
permissions:

.github/workflows/codeowners-legal.yml

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ on:
2020
permissions:
2121
contents: read
2222
pull-requests: write
23+
repository-projects: read
2324

2425
jobs:
2526
codeowners-legal:
@@ -33,7 +34,7 @@ jobs:
3334
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
3435
with:
3536
# Picking this number is a "best guess". If we make it too large,
36-
# the checkout will take potentially unnecessariily long.
37+
# the checkout will take potentially unnecessarily long.
3738
# This reduces the chance that tj-actions/changed-files has to
3839
# fetch deeper history. But if it needs to, it will.
3940
fetch-depth: 10
@@ -58,19 +59,14 @@ jobs:
5859
CHANGED_FILE_PATHS: ${{ steps.changed-files.outputs.all_changed_files }}
5960
CONTENT_TYPE: 'rai'
6061

61-
- name: Add Legal team as a reviewer
62+
- name: Check for reviewers-legal label, add if missing and request review
6263
if: steps.checkContentType.outputs.containsContentType == 'true'
6364
env:
64-
# The GH CLI uses a slightly different env name for
65-
# the token than the GITHUB_TOKEN used by actions
66-
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}
65+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6766
PR: ${{ github.event.pull_request.html_url }}
6867
run: |
69-
has_reviewer=$(
70-
gh pr view $PR --json reviews |
71-
jq 'any(.reviews[]; select(length > 0))'
72-
)
73-
if ! $has_reviewer
74-
then
68+
labels=$(gh pr view ${{ github.event.pull_request.number }} --json labels --jq '.labels[].name')
69+
if ! echo "$labels" | grep -q 'reviewers-legal'; then
7570
gh pr edit $PR --add-reviewer github/legal-product
71+
gh pr edit $PR --add-label reviewers-legal
7672
fi

.github/workflows/purge-fastly.yml

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ name: Purge Fastly
55
# **Who does it impact**: Writers and engineers.
66

77
on:
8+
deployment_status:
89
workflow_dispatch:
910
inputs:
1011
nuke_all:
@@ -16,9 +17,6 @@ on:
1617
description: "Comma separated languages. E.g. 'en,ja, es' (defaults to all)"
1718
required: false
1819
default: ''
19-
push:
20-
branches:
21-
- main
2220

2321
permissions:
2422
contents: read
@@ -29,11 +27,12 @@ env:
2927

3028
jobs:
3129
send-purges:
30+
# Run when workflow_dispatch is the event (manual) or when deployment_status is the event (automatic) and it's a successful production deploy
3231
if: >-
3332
${{
3433
github.repository == 'github/docs-internal' &&
35-
(github.event_name != 'workflow_run' ||
36-
github.event.workflow_run.conclusion == 'success')
34+
(github.event_name != 'deployment_status' ||
35+
github.event.deployment_status.state == 'success' && github.event.deployment_status.environment == 'production')
3736
}}
3837
runs-on: ubuntu-latest
3938
steps:

config/kubernetes/production/deployments/webapp.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ spec:
2323
image: docs-internal
2424
resources:
2525
requests:
26-
cpu: 4000m
27-
memory: 5Gi
26+
cpu: 8000m
27+
memory: 10Gi
2828
limits:
29-
cpu: 4000m
29+
cpu: 16000m
3030
memory: 14Gi
3131
ports:
3232
- name: http

config/moda/deployment.yaml

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,36 @@
1-
required_builds:
2-
- docs-internal-moda-config-bundle / docs-internal-moda-config-bundle
3-
- docs-internal-docker-image / docs-internal-docker-image
4-
- docs-internal-docker-security / docs-internal-docker-security
1+
# Deploy configuration reference: https://thehub.github.com/epd/engineering/products-and-services/internal/moda/reference/deployment-yaml/
2+
53
environments:
64
- name: production
7-
auto_deploy: true
5+
require_pipeline: true
86
cluster_selector:
97
profile: general
108
region: iad
9+
10+
required_builds:
11+
- docs-internal-moda-config-bundle / docs-internal-moda-config-bundle
12+
- docs-internal-docker-image / docs-internal-docker-image
13+
- docs-internal-docker-security / docs-internal-docker-security
14+
15+
# Make the pipeline start automatically when a PR is enqueued
16+
auto_start_pipeline: production_rollout
17+
18+
pipelines:
19+
production_rollout:
20+
thread_notifications: true
21+
notify_users_via_dm: false
22+
timeout: 1200
23+
stages:
24+
- name: full_production
25+
kind: deployment
26+
start_message: We are now going to deploy {{app}}/{{ref}}! Please pause or cancel the pipeline after the deploy if you want more time before auto-merging your pull request(s).
27+
config:
28+
environment: production
29+
timeout: 1200
30+
# gates:
31+
# - kind: timer
32+
# duration: 1200
33+
1134
notifications:
1235
slack_channels:
1336
- '#docs-ops'

content/actions/administering-github-actions/usage-limits-billing-and-administration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ There are some limits on {% data variables.product.prodname_actions %} usage whe
4545
* **Job execution time** - Each job in a workflow can run for up to 6 hours of execution time. If a job reaches this limit, the job is terminated and fails to complete.
4646
{% data reusables.actions.usage-workflow-run-time %}
4747
{% data reusables.actions.usage-api-requests %}
48-
* **Webhook rate limit** - Each repository is limited to 1500 triggered events every 10 seconds.
48+
* **Webhook rate limit** - Each repository is limited to 1500 events triggering a workflow run every 10 seconds. When the limit is reached, the workflow runs that were supposed to be triggered by the webhook events will be blocked and will not be queued.
4949
* **Concurrent jobs** - The number of concurrent jobs you can run in your account depends on your {% data variables.product.prodname_dotcom %} plan, as well as the type of runner used. If exceeded, any additional jobs are queued.
5050

5151
**Standard {% data variables.product.prodname_dotcom %}-hosted runners**

content/actions/hosting-your-own-runners/managing-self-hosted-runners/running-scripts-before-or-after-a-job.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ The scripts are automatically executed when the runner has the following environ
4949
* `ACTIONS_RUNNER_HOOK_JOB_STARTED`: The script defined in this environment variable is triggered when a job has been assigned to a runner, but before the job starts running.
5050
* `ACTIONS_RUNNER_HOOK_JOB_COMPLETED`: The script defined in this environment variable is triggered at the end of the job, after all the steps defined in the workflow have run.
5151

52-
To set these environment variables, you can either add them to the operating system, or add them to a file named `.env` within the self-hosted runner application directory (that is, the directory into which you downloaded and unpacked the runner software). For example, the following `.env` entry will have the runner automatically run a script, saved as `/opt/runner/cleanup_script.sh` on the runner machine, before each job runs:
52+
To set these environment variables, you can either add them to the operating system, or add them to a file named `.env` within the self-hosted runner application directory (that is, the directory into which you downloaded and unpacked the runner software). Note that any change to the `.env` file will require restarting the runner.
53+
For example, the following `.env` entry will have the runner automatically run a script, saved as `/opt/runner/cleanup_script.sh` on the runner machine, before each job runs:
5354

5455
```bash
5556
ACTIONS_RUNNER_HOOK_JOB_STARTED=/opt/runner/cleanup_script.sh

content/actions/hosting-your-own-runners/managing-self-hosted-runners/using-self-hosted-runners-in-a-workflow.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ shortTitle: Use runners in a workflow
1717

1818
You can target self-hosted runners for use in a workflow based on the labels assigned to the runners{% ifversion target-runner-groups %}, or their group membership, or a combination of these{% endif %}.
1919

20-
>[!NOTE]Actions Runner Controller does not support multiple labels, only the name of the runner can be used in place of a label
20+
>[!IMPORTANT]Runner Scale Sets do not support multiple labels, only the name of the runner can be used in place of a label. See [AUTOTITLE](/actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller).
2121
2222
## About self-hosted runner labels
2323

@@ -109,9 +109,9 @@ These labels operate cumulatively, so a self-hosted runner must have all four la
109109

110110
## Routing precedence for self-hosted runners
111111

112-
When routing a job to a self-hosted runner, {% data variables.product.prodname_dotcom %} looks for a runner that matches the job's `runs-on` labels{% ifversion target-runner-groups %} and/or groups{% endif %}:
112+
When routing a job to a self-hosted runner, {% data variables.product.prodname_dotcom %} looks for a runner that matches the job's `runs-on` labels{% ifversion target-runner-groups %} and groups{% endif %}:
113113

114-
* If {% data variables.product.prodname_dotcom %} finds an online and idle runner that matches the job's `runs-on` labels{% ifversion target-runner-groups %} and/or groups{% endif %}, the job is then assigned and sent to the runner.
114+
* If {% data variables.product.prodname_dotcom %} finds an online and idle runner that matches the job's `runs-on` labels{% ifversion target-runner-groups %} and groups{% endif %}, the job is then assigned and sent to the runner.
115115
* If the runner doesn't pick up the assigned job within 60 seconds, the job is re-queued so that a new runner can accept it.
116-
* If {% data variables.product.prodname_dotcom %} doesn't find an online and idle runner that matches the job's `runs-on` labels {% ifversion target-runner-groups %} and/or groups{% endif %}, then the job will remain queued until a runner comes online.
116+
* If {% data variables.product.prodname_dotcom %} doesn't find an online and idle runner that matches the job's `runs-on` labels {% ifversion target-runner-groups %} and groups{% endif %}, then the job will remain queued until a runner comes online.
117117
* If the job remains queued for more than 24 hours, the job will fail.

content/actions/security-for-github-actions/security-hardening-your-deployments/configuring-openid-connect-in-google-cloud-platform.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,16 @@ This guide gives an overview of how to configure GCP to trust {% data variables.
2929

3030
{% data reusables.actions.oidc-on-ghecom %}
3131

32+
{% ifversion ghes %}
33+
{% data reusables.actions.oidc-endpoints %}
34+
<!-- This note is indented to align with the above reusable. -->
35+
36+
> [!NOTE]
37+
> Google Cloud Platform does not have fixed IP ranges defined for these endpoints.
38+
39+
* Make sure that the value of the issuer claim that's included with the JSON Web Token (JWT) is set to a publicly routable URL. For more information, see [AUTOTITLE](/enterprise-server@latest/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect).
40+
{% endif %}
41+
3242
## Adding a Google Cloud Workload Identity Provider
3343

3444
To configure the OIDC identity provider in GCP, you will need to perform the following configuration. For instructions on making these changes, refer to [the GCP documentation](https://github.com/google-github-actions/auth).

content/actions/writing-workflows/quickstart.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ allowTitleToDifferFromFilename: true
55
redirect_from:
66
- /actions/getting-started-with-github-actions/starting-with-preconfigured-workflow-templates
77
- /actions/quickstart
8+
- /actions/getting-started-with-github-actions
89
versions:
910
fpt: '*'
1011
ghes: '*'

content/admin/data-residency/about-github-enterprise-cloud-with-data-residency.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ redirect_from:
1414

1515
By default, {% data variables.product.company_short %} stores data for {% data variables.product.prodname_dotcom_the_website %} in the USA. {% data reusables.data-residency.when-you-adopt-data-residency %} To learn how {% data variables.product.company_short %} handles data storage, see [AUTOTITLE](/admin/data-residency/about-storage-of-your-data-with-data-residency).
1616

17-
Access to this feature is currently managed by {% data variables.contact.contact_enterprise_sales %}.
17+
To get {% data variables.enterprise.data_residency_short %} for your enterprise, **contact {% data variables.contact.contact_sales_data_residency %}**.
1818

1919
## What is {% data variables.product.product_name %}?
2020

@@ -107,7 +107,7 @@ When reading the documentation, readers may need to substitute references to {%
107107

108108
## Getting started
109109

110-
When you have worked with your account team in {% data variables.contact.contact_enterprise_sales %} to create a new enterprise account and choose a subdomain on {% data variables.enterprise.data_residency_site %}, you can get started with your new enterprise.
110+
When you have worked with your account team to create a new enterprise account and choose a subdomain on {% data variables.enterprise.data_residency_site %}, you can get started with your new enterprise.
111111

112112
You will:
113113

content/admin/data-residency/about-storage-of-your-data-with-data-residency.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ redirect_from:
1616

1717
Although your code and user data are stored within your chosen region, {% data variables.product.company_short %} may store certain types of data outside your region, and may need to transfer some data outside your region.
1818

19-
If you are in doubt about any aspect of {% data variables.enterprise.data_residency_short %}, contact your account manager in {% data variables.contact.contact_enterprise_sales %}.
19+
If you are in doubt about any aspect of {% data variables.enterprise.data_residency_short %}, contact your account manager.
2020

2121
## Data stored in your region
2222

content/admin/data-residency/getting-started-with-data-residency-for-github-enterprise-cloud.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ redirect_from:
1717

1818
When you adopt {% data variables.enterprise.data_residency %}, you can choose where your company's code and data are stored.
1919

20-
After you have **worked with {% data variables.contact.contact_enterprise_sales %}** to create an enterprise account with a dedicated URL on {% data variables.enterprise.data_residency_site %}, you'll use this guide to set up your enterprise. You will:
20+
After you have **worked with {% data variables.contact.contact_sales_data_residency %}** to create an enterprise account with a dedicated URL on {% data variables.enterprise.data_residency_site %}, you'll use this guide to set up your enterprise. You will:
2121

2222
* Add users by configuring authentication and provisioning with an identity management system
2323
* Set up billing for your enterprise

content/admin/overview/setting-up-a-trial-of-github-enterprise-cloud.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ shortTitle: Enterprise Cloud trial
1818

1919
You can set up a trial to evaluate the additional features that come with {% data variables.product.prodname_ghe_cloud %}, such as SAML single sign-on (SSO), internal repositories, and audit log streaming. For a list of available features, see our [Pricing](https://github.com/pricing) page.
2020

21-
Your trial **won't** include {% data variables.enterprise.data_residency_short %} on {% data variables.enterprise.data_residency_site %} or access to {% data variables.product.prodname_ghe_server %}. To test these features, contact {% data variables.contact.contact_enterprise_sales %}.
22-
2321
<a href="https://github.com/account/enterprises/new?ref_cta=GHEC+trial&ref_loc=setting+up+a+trial+of+github+enterprise+cloud&ref_page=docs" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Set up a trial of {% data variables.product.prodname_ghe_cloud %}</span> {% octicon "link-external" height:16 %}</a>
2422

23+
>[!IMPORTANT] Your trial enterprise will be hosted in the USA. If you require {% data variables.enterprise.data_residency_short %} outside the USA, contact {% data variables.contact.contact_sales_data_residency %}.
24+
2525
To set up a trial, you must be signed in to a personal account. If you don't have a personal account, see [AUTOTITLE](/free-pro-team@latest/get-started/start-your-journey/creating-an-account-on-github).
2626

2727
You do not need to provide a payment method during the trial.

content/authentication/keeping-your-account-and-data-secure/about-authentication-to-github.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ If you need to use multiple accounts on {% data variables.location.product_locat
5555
* If you enable 2FA, after you successfully enter your username and password, we'll also prompt you to provide a code that's generated by a time-based one time password (TOTP) application on your mobile device{% ifversion fpt or ghec %} or sent as a text message (SMS).{% endif %}{% ifversion 2fa-check-up-period %}
5656
* After you configure 2FA, your account enters a check up period for 28 days. You can leave the check up period by successfully performing 2FA within those 28 days. If you don't perform 2FA in that timespan, you'll then be asked to perform 2FA inside one of your existing {% data variables.product.prodname_dotcom %} sessions.
5757
* If you cannot perform 2FA to pass the 28th day checkup, you will be provided a shortcut that lets you reconfigure your 2FA settings. You must reconfigure your settings before you can access the rest of {% data variables.product.prodname_dotcom %}{% endif %}. For more information, see [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication#providing-a-2fa-code-when-signing-in-to-the-website){% ifversion 2fa-check-up-period %} and [AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication){% endif %}.
58-
* In addition to authentication with a TOTP application{% ifversion fpt or ghec %} or a text message{% endif %}, you can optionally add an alternative method of authentication with {% ifversion fpt or ghec %}{% data variables.product.prodname_mobile %} or{% endif %} a security key using WebAuthn. For more information, see {% ifversion fpt or ghec %}[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-github-mobile) and {% endif %}[AUTOTITLE](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key).
58+
* In addition to authentication with a TOTP application{% ifversion fpt or ghec %} or a text message{% endif %}, you can optionally add an alternative method of authentication with {% ifversion fpt or ghec %}{% data variables.product.prodname_mobile %} or{% endif %} a security key using WebAuthn. See {% ifversion fpt or ghec %}[Configuring two-factor authentication using {% data variables.product.prodname_mobile %}](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-github-mobile) or {% endif %}[Configuring two-factor authentication using a security key](/authentication/securing-your-account-with-two-factor-authentication-2fa/configuring-two-factor-authentication#configuring-two-factor-authentication-using-a-security-key).
5959

6060
{% ifversion fpt or ghec %}
6161

0 commit comments

Comments
 (0)