Skip to content

Commit 0b1165e

Browse files
authored
Merge branch 'main' into code-scanning-alerts-default-branch
2 parents a1da271 + b415f7f commit 0b1165e

File tree

263 files changed

+5353
-2510
lines changed

Some content is hidden

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

263 files changed

+5353
-2510
lines changed

.devcontainer/devcontainer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"davidanson.vscode-markdownlint",
2323
"bierner.markdown-preview-github-styles",
2424
"streetsidesoftware.code-spell-checker",
25-
"hubwriter.open-reusable"
25+
"docs.open-reusables"
2626
],
2727

2828
// Use 'forwardPorts' to make a list of ports inside the container available locally.

.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/workflows/azure-preview-env-deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ jobs:
165165
rsync -rptovR ./user-code/content/./**/*.md ./content
166166
rsync -rptovR ./user-code/assets/./**/*.png ./assets
167167
rsync -rptovR ./user-code/data/./**/*.{yml,md} ./data
168-
rsync -rptovR ./user-code/components/./**/*.{ts,tsx} ./components
168+
rsync -rptovR ./user-code/components/./**/*.{scss,ts,tsx} ./components
169169
rsync -rptovR --ignore-missing-args ./user-code/lib/./**/*.{js,ts} ./lib
170170
rsync -rptovR --ignore-missing-args ./user-code/middleware/./**/*.{js,ts} ./middleware
171171
rsync -rptovR ./user-code/pages/./**/*.tsx ./pages
4.9 KB
Loading

components/article/ClientSideHighlightJS.tsx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,10 @@ export default function ClientSideHighlightJS() {
6666
intersectionObserver.observe(element)
6767
}
6868
}
69+
70+
return () => {
71+
intersectionObserver.disconnect()
72+
}
6973
}, [asPath])
7074

7175
return null

components/rest/CodeBlock.module.scss

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,4 @@
11
.codeBlock {
2-
pre {
3-
margin-bottom: 0;
4-
border: 1px solid var(--color-border-default);
5-
max-height: 32rem;
6-
overflow: auto;
7-
}
2+
max-height: 32rem;
3+
overflow: auto;
84
}

components/rest/CodeBlock.tsx

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export function CodeBlock({ verb, headingLang, codeBlock, highlight }: Props) {
2020
})
2121

2222
return (
23-
<div className="code-extra">
23+
<div className={headingLang && 'code-extra'}>
2424
{headingLang && (
2525
<header className="d-flex flex-justify-between flex-items-center p-2 text-small rounded-top-1 border">
2626
{headingLang === 'JavaScript' ? (
@@ -41,13 +41,7 @@ export function CodeBlock({ verb, headingLang, codeBlock, highlight }: Props) {
4141
</Tooltip>
4242
</header>
4343
)}
44-
<pre
45-
className={cx(
46-
styles.methodCodeBlock,
47-
'd-flex flex-justify-between flex-items-center rounded-1 border'
48-
)}
49-
data-highlight={highlight}
50-
>
44+
<pre className={cx(styles.codeBlock, 'rounded-1 border')} data-highlight={highlight}>
5145
<code>
5246
{verb && (
5347
<span className="color-bg-accent-emphasis color-fg-on-emphasis rounded-1 text-uppercase p-1">

content/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ You can disable {% data variables.product.prodname_dependabot_security_updates %
3737

3838
## Supported repositories
3939

40-
{% data variables.product.prodname_dotcom %} automatically enables {% data variables.product.prodname_dependabot_security_updates %} for every repository that meets these prerequisites.
40+
{% data variables.product.prodname_dotcom %} automatically enables {% data variables.product.prodname_dependabot_security_updates %} for every repository that meets these prerequisites.
4141

4242
{% note %}
4343

@@ -59,7 +59,7 @@ If security updates are not enabled for your repository and you don't know why,
5959

6060
You can enable or disable {% data variables.product.prodname_dependabot_security_updates %} for an individual repository (see below).
6161

62-
You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
62+
You can also enable or disable {% data variables.product.prodname_dependabot_security_updates %} for all repositories owned by your user account or organization. For more information, see "[Managing security and analysis settings for your user account](/github/setting-up-and-managing-your-github-user-account/managing-security-and-analysis-settings-for-your-user-account)" or "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)."
6363

6464
{% data variables.product.prodname_dependabot_security_updates %} require specific repository settings. For more information, see "[Supported repositories](#supported-repositories)."
6565

@@ -68,7 +68,7 @@ You can also enable or disable {% data variables.product.prodname_dependabot_sec
6868
{% data reusables.repositories.navigate-to-repo %}
6969
{% data reusables.repositories.sidebar-settings %}
7070
{% data reusables.repositories.navigate-to-security-and-analysis %}
71-
1. Under "Code security and analysis", to the right of "{% data variables.product.prodname_dependabot %} security updates", click **Enable** or **Disable**.
71+
1. Under "Code security and analysis", to the right of "{% data variables.product.prodname_dependabot %} security updates", click **Enable** to enable the feature or **Disable** to disable it. {% ifversion fpt or ghec %}For public repositories, the button is disabled if the feature is always enabled.{% endif %}
7272
{% ifversion fpt or ghec %}!["Code security and analysis" section with button to enable {% data variables.product.prodname_dependabot_security_updates %}](/assets/images/help/repository/enable-dependabot-security-updates-button.png){% else %}!["Code security and analysis" section with button to enable {% data variables.product.prodname_dependabot_security_updates %}](/assets/images/enterprise/3.3/repository/security-and-analysis-disable-or-enable-ghes.png){% endif %}
7373

7474

content/code-security/supply-chain-security/understanding-your-software-supply-chain/about-the-dependency-graph.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ The recommended formats explicitly define which versions are used for all direct
8484
{%- endif %}
8585
| Maven | Java, Scala | `pom.xml` | `pom.xml` |
8686
| npm | JavaScript | `package-lock.json` | `package-lock.json`, `package.json`|
87-
| Python PIP | Python | `requirements.txt`, `pipfile.lock` | `requirements.txt`, `pipfile`, `pipfile.lock`, `setup.py`{% if github-actions-in-dependency-graph %}<sup>[2]</sup>{% else %}<sup>[1]</sup>{% endif %} |
87+
| pip | Python | `requirements.txt`, `pipfile.lock` | `requirements.txt`, `pipfile`, `pipfile.lock`, `setup.py`{% if github-actions-in-dependency-graph %}<sup>[2]</sup>{% else %}<sup>[1]</sup>{% endif %} |
8888
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4752 %}
8989
| Python Poetry | Python | `poetry.lock` | `poetry.lock`, `pyproject.toml` |{% endif %}
9090
| RubyGems | Ruby | `Gemfile.lock` | `Gemfile.lock`, `Gemfile`, `*.gemspec` |

content/code-security/supply-chain-security/understanding-your-software-supply-chain/exploring-the-dependencies-of-a-repository.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Enterprise owners can configure the dependency graph at an enterprise level. For
4040
### Dependencies view
4141

4242
{% ifversion fpt or ghec %}
43-
Dependencies are grouped by ecosystem. You can expand a dependency to view its dependencies. For dependencies on public repositories hosted on {% data variables.product.product_name %}, you can also click a dependency to view the repository. Dependencies on private repositories, private packages, or unrecognized files are shown in plain text.
43+
Dependencies are grouped by ecosystem. You can expand a dependency to view its dependencies. Dependencies on private repositories, private packages, or unrecognized files are shown in plain text. If the package manager for the dependency is in a public repository, {% data variables.product.product_name %} will display a link to that repository.
4444

4545
If vulnerabilities have been detected in the repository, these are shown at the top of the view for users with access to {% data variables.product.prodname_dependabot_alerts %}.
4646

@@ -84,7 +84,10 @@ You can disable the dependency graph at any time by clicking **Disable** next to
8484

8585
## Changing the "Used by" package
8686

87-
If the dependency graph is enabled, and your repository contains a package that's published on a supported package ecosystem, {% data variables.product.prodname_dotcom %} displays a "Used by" section in the sidebar of the **Code** tab of your repository. For more information about the supported package ecosystems, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems)."
87+
You may notice some repositories have a "Used by" section in the sidebar of the **Code** tab. Your repository will have a "Used by" section if:
88+
* The dependency graph is enabled for the repository (see the above section for more details).
89+
* Your repository contains a package that is published on a [supported package ecosystem](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph#supported-package-ecosystems).
90+
* Within the ecosystem, your package has a link to a _public_ repository where the source is stored.
8891

8992
The "Used by" section shows the number of public references to the package that were found, and displays the avatars of some of the owners of the dependent projects.
9093

0 commit comments

Comments
 (0)