Skip to content

Commit

Permalink
Merge branch 'github:main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
Adawntoremember authored May 29, 2024
2 parents a7112b5 + 63573b3 commit c9d07f1
Show file tree
Hide file tree
Showing 5,251 changed files with 2,357,754 additions and 2,872,223 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
6 changes: 3 additions & 3 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# See here for image contents: https://github.com/microsoft/vscode-dev-containers/blob/main/containers/javascript-node/.devcontainer/base.Dockerfile
# To find available Node images, see https://mcr.microsoft.com/en-us/product/devcontainers/javascript-node/tags

# [Choice] Node.js version
ARG VARIANT="18-buster"
FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT}
ARG VARIANT="dev-20-bullseye"
FROM mcr.microsoft.com/devcontainers/javascript-node:${VARIANT}

# [Optional] Uncomment this section to install additional OS packages.
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
Expand Down
15 changes: 7 additions & 8 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,7 @@
"build": {
"dockerfile": "Dockerfile",
// Update 'VARIANT' to pick a Node version
"args": { "VARIANT": "18" }
},

// Set *default* container specific settings.json values on container create.
"settings": {
"terminal.integrated.shell.linux": "/bin/bash",
"cSpell.language": ",en"
"args": { "VARIANT": "20" }
},

// Install features. Type 'feature' in the VS Code command palette for a full list.
Expand All @@ -22,7 +16,11 @@

"customizations": {
"vscode": {
"settings": {},
// Set *default* container specific settings.json values on container create.
"settings": {
"terminal.integrated.shell.linux": "/bin/bash",
"cSpell.language": ",en"
},
// Visual Studio Code extensions which help authoring for docs.github.com.
"extensions": [
"dbaeumer.vscode-eslint",
Expand All @@ -31,6 +29,7 @@
"bierner.markdown-preview-github-styles",
"streetsidesoftware.code-spell-checker",
"alistairchristie.open-reusables",
"AlistairChristie.version-identifier",
"GitHub.copilot",
"GitHub.copilot-chat"
]
Expand Down
2 changes: 1 addition & 1 deletion .devcontainer/library-scripts/github-debian.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
#-------------------------------------------------------------------------------------------------------------
#
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/master/script-library/docs/github.md
# Docs: https://github.com/microsoft/vscode-dev-containers/blob/main/script-library/docs/github-cli.md
#
# Syntax: ./github-debian.sh [version]

Expand Down
27 changes: 0 additions & 27 deletions .devcontainer/test-custom-devcontainer/devcontainer.json

This file was deleted.

2 changes: 1 addition & 1 deletion .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Community leaders will follow these Community Impact Guidelines in determining t

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the community.

Expand Down
14 changes: 7 additions & 7 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approacha

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Use the table of contents icon <img src="/contributing/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.
Use the table of contents icon <img alt="Table of contents icon" src="/contributing/images/table-of-contents.png" width="25" height="25" /> on the top left corner of this document to get to a specific section of this guide quickly.

## New contributor guide

To get an overview of the project, read the [README](README.md) file. Here are some resources to help you get started with open source contributions:
To get an overview of the project, read the [README](../README.md) file. Here are some resources to help you get started with open source contributions:

- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
- [Set up Git](https://docs.github.com/en/get-started/getting-started-with-git/set-up-git)
- [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow)
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)


## Getting started

To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Makrdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs).
To navigate our codebase with confidence, see [the introduction to working in the docs repository](/contributing/README.md) :confetti_ball:. For more information on how we write our markdown files, see "[Using Markdown and Liquid in GitHub Docs](https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs)."

Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:.

Expand Down Expand Up @@ -56,13 +56,13 @@ For more information about using a codespace for working on GitHub documentation
- Using the command line:
- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.

2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see [the development guide](contributing/development.md).
2. Install or update to **Node.js**, at the version specified in `.node-version`. For more information, see [the development guide](../contributing/development.md).

3. Create a working branch and start with your changes!

### Commit your update

Commit the changes once you are happy with them. Don't forget to use the "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist) to speed up the review process :zap:.
Commit the changes once you are happy with them. Don't forget to use the "[Self review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist)" to speed up the review process :zap:.

### Pull Request

Expand Down
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/improve-existing-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ body:
value: |
**HUBBERS!!** This is the github/docs open source repo. You may want to open an issue in the internal-only github/docs-content repo instead.
* For questions, ask in [Discussions](https://github.com/github/docs/discussions).
* Before you file an issue read the [Contributing guide](https://docs.github.com/en/contributing).
* Check to make sure someone hasn't already opened a similar [issue](https://github.com/github/docs/issues).
Expand Down
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/improve-the-site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ body:
value: |
**HUBBERS!!** This is the github/docs open source repo. You may want to open an issue in the internal-only github/docs-content repo instead.
* For questions, ask in [Discussions](https://github.com/github/docs/discussions).
* Before you file an issue read the [Contributing guide](https://docs.github.com/en/contributing).
* Check to make sure someone hasn't already opened a similar [issue](https://github.com/github/docs/issues).
Expand All @@ -18,7 +17,7 @@ body:
label: Code of Conduct
description: This project has a Code of Conduct that all participants are expected to understand and follow.
options:
- label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)
- label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/.github/CODE_OF_CONDUCT.md)
required: true

- type: textarea
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ body:
label: Code of Conduct
description: This project has a Code of Conduct that all participants are expected to understand and follow.
options:
- label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md)
- label: I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/.github/CODE_OF_CONDUCT.md)
required: true
- type: checkboxes
attributes:
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ If you made changes to the `content` directory, a table will populate in a comme

### Check off the following:

- [ ] I have reviewed my changes in staging, available via the **View deployment** link in this PR's timeline.
- [ ] I have reviewed my changes in staging, available via the **View deployment** link in this PR's timeline (this link will be available after opening the PR).

- For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the `data` directory.
- [ ] For content changes, I have completed the [self-review checklist](https://docs.github.com/en/contributing/collaborating-on-github-docs/self-review-checklist).
2 changes: 1 addition & 1 deletion .github/actions/cache-nextjs/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ runs:
using: 'composite'
steps:
- name: Cache .next/cache
uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8 # pin @3.3.1
uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4.0.0
with:
path: ${{ github.workspace }}/.next/cache
# Generate a new cache whenever packages or source files change.
Expand Down
16 changes: 8 additions & 8 deletions .github/actions/clone-translations/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,56 +11,56 @@ runs:
using: 'composite'
steps:
- name: Clone Simplified Chinese
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
repository: github/docs-internal.zh-cn
token: ${{ inputs.token }}
path: translations/zh-cn

- name: Clone Spanish
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
repository: github/docs-internal.es-es
token: ${{ inputs.token }}
path: translations/es-es

- name: Clone Portuguese
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
repository: github/docs-internal.pt-br
token: ${{ inputs.token }}
path: translations/pt-br

- name: Clone Russian
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
repository: github/docs-internal.ru-ru
token: ${{ inputs.token }}
path: translations/ru-ru

- name: Clone Japanese
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
repository: github/docs-internal.ja-jp
token: ${{ inputs.token }}
path: translations/ja-jp

- name: Clone French
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
repository: github/docs-internal.fr-fr
token: ${{ inputs.token }}
path: translations/fr-fr

- name: Clone German
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
repository: github/docs-internal.de-de
token: ${{ inputs.token }}
path: translations/de-de

- name: Clone Korean
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
repository: github/docs-internal.ko-kr
token: ${{ inputs.token }}
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/get-docs-early-access/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ runs:
run: node src/early-access/scripts/what-docs-early-access-branch.js

- name: Clone
uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
with:
repository: github/docs-early-access
token: ${{ inputs.token }}
Expand Down
21 changes: 21 additions & 0 deletions .github/actions/install-cocofix/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Install CocoFix

description: Installs the private package `@github/cocofix` from the GitHub Package Registry.

inputs:
token:
description: PAT
required: true

runs:
using: 'composite'
steps:
- name: Install CoCoFix
shell: bash
env:
TOKEN: ${{ inputs.token }}
run: |
npm install --no-save \
'--@github:registry=https://npm.pkg.github.com' \
'--//npm.pkg.github.com/:_authToken=${TOKEN}' \
@github/cocofix
4 changes: 2 additions & 2 deletions .github/actions/node-npm-setup/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ runs:
using: 'composite'
steps:
- name: Cache node_modules
uses: actions/cache@88522ab9f39a2ea568f7027eddc7d8d8bc9d59c8
uses: actions/cache@13aacd865c20de90d75de3b17ebe84f7a17d57d2 # v4.0.0
id: cache-node_modules
env:
# Default is 10 min, per segment, but we can make it much smaller
Expand All @@ -17,7 +17,7 @@ runs:
key: ${{ runner.os }}-node_modules-${{ hashFiles('package*.json') }}-${{ hashFiles('.github/actions/node-npm-setup/action.yml') }}

- name: Setup Node.js
uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
with:
node-version-file: 'package.json'
cache: npm
Expand Down
46 changes: 46 additions & 0 deletions .github/actions/precompute-pageinfo/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Warmup pageinfo cache

description: Run this to create a .pageinfo-cache.json.br file

inputs:
restore-only:
description: Only attempt to restore, don't warm up
required: false

runs:
using: 'composite'
steps:
# The caching technique here is to "unboundedly" add to the cache.
# By unboundedly, it means the cached item will grow and grow.
# The general idea is that we A) restore from cache, B) replace the
# file by running the script, and C) save the file back to cache.
# Optionally, you can have it just do A (and not B and C).

- name: Cache .pageinfo-cache.json.br (restore)
# You can't use a SHA on these. Only possible with `actions/cache@SHA...`
uses: actions/cache/restore@v3
with:
path: .pageinfo-cache.json.br
key: pageinfo-cache-
restore-keys: pageinfo-cache-

# When we use this composite action from the workflows like
# Azure Preview Deploy and Azure Production Deploy, we don't have
# any Node installed or any of its packages. I.e. we never
# run `npm ci` in those actions. For security sake.
# So we can't do things that require Node code.
# Tests and others will omit the `restore-only` input, but
# prepping for Docker build and push, will set it to a non-empty
# string which basically means "If you can restore it, great.
# If not, that's fine, don't bother".
- name: Run script
if: ${{ inputs.restore-only == '' }}
shell: bash
run: npm run precompute-pageinfo -- --max-versions 2

- name: Cache .remotejson-cache (save)
if: ${{ inputs.restore-only == '' }}
uses: actions/cache/save@v3
with:
path: .pageinfo-cache.json.br
key: pageinfo-cache-${{ github.sha }}
4 changes: 2 additions & 2 deletions .github/actions/setup-elasticsearch/action.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Set up local Elasticsearch

description: Install a local Elasticseach with version that matches prod
description: Install a local Elasticsearch with version that matches prod

inputs:
token:
Expand All @@ -17,7 +17,7 @@ runs:
with:
# Make sure this matches production
# It might also need to match what's available on Docker hub
elasticsearch version: '8.8.2'
elasticsearch version: '8.12.0'
host port: 9200
container port: 9200
host node port: 9300
Expand Down
2 changes: 1 addition & 1 deletion .github/actions/slack-alert/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ runs:
using: composite
steps:
- name: Send Slack notification if workflow fails
uses: someimportantcompany/github-actions-slack-message@1d367080235edfa53df415bd8e0bbab480f29bad
uses: someimportantcompany/github-actions-slack-message@a975b440de2bcef178d451cc70d4c1161b5a30cd
with:
channel: ${{ inputs.slack_channel_id }}
bot-token: ${{ inputs.slack_token }}
Expand Down
3 changes: 3 additions & 0 deletions .github/branch_protection_settings/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Branch Protection Settings

This directory is mean to store a dump of the branch protections rules we have set in this repo. They are used by a workflow to compare against what is actually in settings in order to alert to changes.
Loading

0 comments on commit c9d07f1

Please sign in to comment.