Skip to content

Commit 9176a26

Browse files
author
Martin Lopes
authored
Merge branch 'main' into pwsh-commands
2 parents 3d1de14 + 26c2b97 commit 9176a26

File tree

1,264 files changed

+241432
-678041
lines changed

Some content is hidden

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

1,264 files changed

+241432
-678041
lines changed

.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,5 @@ In your `docs-internal` checkout:
7878
- [ ] In `github/github`, edit the release's config file in `app/api/description/config/releases/`, and change `deprecated: false` to `deprecated: true`.
7979
- [ ] Open a new PR, and get the required code owner approvals. A docs-content team member can approve it for the docs team.
8080
- [ ] When the PR is approved, [deploy the `github/github` PR](https://thehub.github.com/engineering/devops/deployment/deploying-dotcom/). If you haven't deployed a `github/github` PR before, work with someone that has -- the process isn't too involved depending on how you deploy, but there are a lot of details that can potentially be confusing as you can see from the documentation.
81+
82+
**Note**: you can do this step independently of the other steps after a GHES version is deprecated since it should no longer get updates in github/github. You should plan to get this PR merged as soon as possible, otherwise if you wait too long our OpenAPI automation may re-add the static files that you removed in step 5.

.github/actions-scripts/enterprise-server-issue-templates/release-issue.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -98,27 +98,37 @@ This file should be automatically updated, but you can also run `script/update-e
9898
9999
### Before shipping the release branch
100100
101-
- [ ] Add the GHES release notes to `data/release-notes/` and update the versioning frontmatter in `content/admin/release-notes.md` to `enterprise-server: '<=<RELEASE>'`
101+
- [ ] Add the GHES release notes to `data/release-notes/`.
102102
- [ ] Add any required smoke tests to the opening post in the megabranch PR.
103103
104104
Usually, we should smoke test any new GHES admin guides, any large features landing in this GHES version for the first time, and the REST and GraphQL API references.
105-
- [ ] Alert the Neon Squad (formally docs-ecosystem team) 1-2 days before the release to deploy to `github/github`. A PR should already be open in `github/github`, to change `published` to `true` in `app/api/description/config/releases/ghes-<NEXT RELEASE NUMBER>.yaml`. They will need to:
105+
- [ ] A few days before shipping, check for broken links. Run `script/check-english-links.js` in a local copy of the megabranch.
106+
- [ ] [Freeze the repos](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/freezing.md) at least 1-2 days before the release, and post an announcement in Slack so everybody knows. It's helpful to freeze the repos before doing the OpenAPI merges to avoid changes to the megabranch while preparing and deploying.
107+
- [ ] Alert the Neon Squad (formally docs-ecosystem team) 1-2 days before the release to deploy to `github/github`. A PR should already be open in `github/github`, to change the OpenAPI schema config `published` to `true` in `app/api/description/config/releases/ghes-<NEXT RELEASE NUMBER>.yaml`. They will need to:
106108
- [ ] Get the required approval from `@github/ecosystem-api-reviewers` then deploy the PR to dotcom. This process generally takes 30-90 minutes.
107-
- [ ] Once the PR merges, make sure that the auto-generated PR titled "Update OpenAPI Descriptions" in doc-internal contains both the derefrenced and decorated JSON files for the new GHES release. If everything looks good, merge the "Update OpenAPI Description" PR into the GHES release megabranch. **Note:** Be careful about resolving the conflicts correctly—you may wish to delete the existing OpenAPI files for the release version from the megabranch, so there are no conflicts to resolve and to ensure that the incoming artifacts are the correct ones.
108-
- [ ] Add a blocking review to the auto-generated "Update OpenAPI Descriptions" PR in the public REST API description. (Remove this blocking review once the GHES release ships.)
109-
- [ ] [Freeze the repos](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/freezing.md) at least 1-2 days before the release, and post an announcement in Slack so everybody knows.
109+
- [ ] Once the PR merges, make sure that the auto-generated PR titled "Update OpenAPI Descriptions" in doc-internal contains both the dereferenced and decorated JSON files for the new GHES release. If everything looks good, merge the "Update OpenAPI Description" PR into the GHES release megabranch. **Note:** Be careful about resolving the conflicts correctly—you may wish to delete the existing OpenAPI files for the release version from the megabranch (that is, delete the GHES release version `lib/rest/static` decorated and dereferenced JSON files), so there are no conflicts to resolve and to ensure that the incoming artifacts are the correct ones.
110+
- [ ] Alert the Ecosystem-API team in #ecosystem-api about the pending release freeze and incoming blocking review of OpenAPI updates in the public REST API description (the `rest-api-descriptions` repo). They'll need to block any future "Update OpenAPI Descriptions" PRs in the public REST API description until after the ship.
111+
- [ ] Add a blocking review to the auto-generated "Update OpenAPI Descriptions" PR in the public REST API description. (You or they will remove this blocking review once the GHES release ships.)
112+
110113
111114
### 🚢 🛳️ 🚢 Shipping the release branch
112115
113116
- [ ] Remove `[DO NOT MERGE]` and other meta information from the PR title 😜.
114117
- [ ] The `github/docs-internal` repo is frozen, and the `Repo Freeze Check / Prevent merging during deployment freezes (pull_request_target)` test is expected to fail.
115118
116119
Use admin permissions to ship the release branch with this failure. Make sure that the merge's commit title does not include anything like `[DO NOT MERGE]`, and remove all the branch's commit details from the merge's commit message except for the co-author list.
117-
- [ ] Do any required smoke tests listed in the opening post in the megabranch PR.
120+
- [ ] Do any required smoke tests listed in the opening post in the megabranch PR. You can monitor and check when the production deploy completed by viewing the [`docs-internal` deployments page](https://github.com/github/docs-internal/deployments).
118121
- [ ] Once smoke tests have passed, you can [unfreeze the repos](https://github.com/github/docs-content/blob/main/docs-content-docs/docs-content-workflows/freezing.md) and post an announcement in Slack.
119-
- [ ] After unfreezing, push the search index LFS objects for the public `github/docs` repo. The LFS objects were already being pushed for the internal repo after the `sync-english-index-for-<PLAN@RELEASE>` was added to the megabranch. To push the LFS objects, run the [search sync workflow](https://github.com/github/docs-internal/actions/workflows/sync-search-indices.yml). Once you're there, click on `Run workflow` button. A modal will pop up where you can set the following inputs:
120-
Branch: The new version megabranch you're working on
121-
version: `enterprise-server@<RELEASE>`
122-
language: `en`
122+
- [ ] After unfreezing, the megabranch creator should push the search index LFS objects for the public `github/docs` repo. The LFS objects were already pushed for the internal repo after the `sync-english-index-for-<PLAN@RELEASE>` was added to the megabranch. To push the LFS objects to the public repo:
123+
1. First navigate to the [sync search indices workflow](https://github.com/github/docs-internal/actions/workflows/sync-search-indices.yml).
124+
2. Then, to run the workflow with parameters, click on `Run workflow` button.
125+
3. A modal will pop up where you will set the following inputs:
126+
- Branch: The new version megabranch you're working on
127+
- Version: `enterprise-server@<RELEASE>`
128+
- Language: `en`
129+
4. Run the job. The workflow job may fail on the first run—so retry the failed job if needed.
130+
- [ ] After unfreezing, alert the Ecosystem-API team in #ecosystem-api the docs freeze is finished/thawed and the release has shipped.
131+
- [ ] You (or they) can now remove your blocking review on the auto-generated "Update OpenAPI Descriptions" PR in public REST API description (the `rest-api-descriptions` repo). (although it's likely newer PRs have been created since yours with the blocking review, in which case the Ecosystem-API team will close your PR and perform the next step on the most recent PR).
132+
- [ ] The Ecosystem-API team will merge the latest auto-generated "Update OpenAPI Descriptions" PR (which will contain the OpenAPI schema config that changed `published` to `true` for the release).
123133
- [ ] After unfreezing, if there were significant or highlighted GraphQL changes in the release, consider manually running the [GraphQL update workflow](https://github.com/github/docs-internal/actions/workflows/update-graphql-files.yml) to update our GraphQL schemas. By default this workflow only runs once every 24 hours.
124134
- [ ] After the release, in the `docs-content` repo, add the now live version number to the "Specific GHES version(s)" section in the following files: [`.github/ISSUE_TEMPLATE/release-tier-1-or-2-tracking.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-1-or-2-tracking.yml) and [`.github/ISSUE_TEMPLATE/release-tier-3-or-tier-4.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-3-or-tier-4.yml). When the PR is approved, merge it in.

.github/dependabot.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,3 @@ updates:
2626
schedule:
2727
interval: weekly
2828
day: thursday
29-
ignore:
30-
- dependency-name: '*'
31-
update-types:
32-
['version-update:semver-patch', 'version-update:semver-minor']

.github/workflows/azure-preview-env-deploy.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ on:
2727
description: 'The commit SHA to build'
2828
type: string
2929
required: true
30+
push:
31+
branches:
32+
- gh-readonly-queue/main/**
3033

3134
permissions:
3235
contents: read
@@ -50,7 +53,7 @@ jobs:
5053
# to link a PR to a list of environments later.
5154
url: ${{ env.APP_URL }}
5255
env:
53-
PR_NUMBER: ${{ github.event.number || github.event.inputs.PR_NUMBER }}
56+
PR_NUMBER: ${{ github.event.number || github.event.inputs.PR_NUMBER || github.run_id }}
5457
COMMIT_REF: ${{ github.event.pull_request.head.sha || github.event.inputs.COMMIT_REF }}
5558
BRANCH_NAME: ${{ github.head_ref || github.ref_name }}
5659
IS_INTERNAL_BUILD: ${{ github.repository == 'github/docs-internal' }}
@@ -162,7 +165,7 @@ jobs:
162165
rsync -rptovR ./user-code/content/./**/*.md ./content
163166
rsync -rptovR ./user-code/assets/./**/*.png ./assets
164167
rsync -rptovR ./user-code/data/./**/*.{yml,md} ./data
165-
rsync -rptovR ./user-code/components/./**/*.{ts,tsx} ./components
168+
rsync -rptovR ./user-code/components/./**/*.{scss,ts,tsx} ./components
166169
rsync -rptovR --ignore-missing-args ./user-code/lib/./**/*.{js,ts} ./lib
167170
rsync -rptovR --ignore-missing-args ./user-code/middleware/./**/*.{js,ts} ./middleware
168171
rsync -rptovR ./user-code/pages/./**/*.tsx ./pages

.github/workflows/azure-preview-env-destroy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ jobs:
6161
# This will fail if the IMAGE_REPO doesn't exist, but we don't care
6262
- name: 'Untag all docker images for this PR'
6363
run: |
64-
az acr repository delete -n ${{ secrets.NONPROD_REGISTRY_NAME }} --repository ${{ env.IMAGE_REPO }} -y || true
64+
az acr repository delete -n ${{ secrets.NONPROD_REGISTRY_SERVER }} --repository ${{ env.IMAGE_REPO }} -y || true
6565
6666
# Remove all GitHub deployments from this environment and remove the environment
6767
- uses: strumwolf/delete-deployment-environment@45c821e46baa405e25410700fe2e9643929706a0

.github/workflows/link-check-all.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ on:
99
push:
1010
branches:
1111
- main
12+
- gh-readonly-queue/main/**
1213
pull_request:
1314

1415
permissions:

.github/workflows/openapi-decorate.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ jobs:
5757
uses: EndBug/add-and-commit@756d9ea820f11931e591eaf57f25e0f5b903d5b2
5858
with:
5959
# The arguments for the `git add` command
60-
add: 'lib/rest/static/decorated'
60+
add: '["lib/rest/static/apps", "lib/rest/static/decorated"]'
6161

6262
# The message for the commit
6363
message: 'Add decorated OpenAPI schema files'

.github/workflows/orphaned-assets-check.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ name: 'Orphaned assets check'
66

77
on:
88
pull_request:
9+
push:
10+
branches:
11+
- gh-readonly-queue/main/**
912

1013
permissions:
1114
contents: read

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@ on:
1515
- unlocked
1616
branches:
1717
- main
18+
push:
19+
branches:
20+
- gh-readonly-queue/main/**
1821

1922
permissions:
2023
contents: none

.github/workflows/test.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ name: Node.js Tests
77
on:
88
workflow_dispatch:
99
pull_request:
10+
push:
11+
branches:
12+
- gh-readonly-queue/main/**
1013

1114
permissions:
1215
contents: read

0 commit comments

Comments
 (0)