Skip to content

Commit 0956f7f

Browse files
Merge branch 'main' into gdomingu-patch-1
2 parents ef36fd1 + 26d4f3c commit 0956f7f

File tree

760 files changed

+5860
-3384
lines changed

Some content is hidden

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

760 files changed

+5860
-3384
lines changed

.gitattributes

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22
* text=auto
33
# Explicitly declare text files we want to always be normalized and converted
44
# to native line endings on checkout.
5-
*.md text
5+
*.md text diff=markdown
66
*.json.br filter=lfs diff=lfs merge=lfs -text

.github/workflows/move-help-wanted-issues.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ jobs:
2323
steps:
2424
- uses: alex-page/github-project-automation-plus@bb266ff4dde9242060e2d5418e120a133586d488
2525
with:
26-
project: Docs team reviews
26+
project: Docs open source board
2727
column: Help wanted
2828
repo-token: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}

.github/workflows/openapi-decorate.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ jobs:
5757
uses: EndBug/add-and-commit@050a66787244b10a4874a2a5f682130263edc192
5858
with:
5959
# The arguments for the `git add` command
60-
add: '["lib/rest/static/apps", "lib/rest/static/decorated"]'
60+
add: '["lib/rest/static/apps", "lib/rest/static/decorated", "lib/redirects/static/client-side-rest-api-redirects.json"]'
6161

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

.husky/post-checkout

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ then
77
printf >&2 "\nGitHub Docs requires Git LFS but using the 'git-lfs' on your path failed.\n"
88
fi
99
else
10-
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://git.io/JBCId>.\n"
10+
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage>.\n"
1111
fi

.husky/post-commit

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ then
77
printf >&2 "\nGitHub Docs requires Git LFS but using the 'git-lfs' on your path failed.\n"
88
fi
99
else
10-
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://git.io/JBCId>.\n"
10+
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage>.\n"
1111
fi

.husky/post-merge

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ then
77
printf >&2 "\nGitHub Docs requires Git LFS but using the 'git-lfs' on your path failed.\n"
88
fi
99
else
10-
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://git.io/JBCId>.\n"
10+
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage>.\n"
1111
fi

.husky/pre-push

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ then
77
printf >&2 "\nGitHub Docs requires Git LFS but using the 'git-lfs' on your path failed.\n"
88
fi
99
else
10-
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://git.io/JBCId>.\n"
10+
printf >&2 "\nGitHub Docs requires Git LFS but 'git-lfs' was not found on your path.\nLearn how to install Git LFS at <https://docs.github.com/en/github/managing-large-files/versioning-large-files/installing-git-large-file-storage>.\n"
1111
fi
1212

1313
. "$(dirname "$0")/_/husky.sh"
Loading
Loading
Loading
Loading
Loading
Loading
31.6 KB
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

components/article/ToolPicker.tsx

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { useEffect, useState } from 'react'
2+
import { useRouter } from 'next/router'
23
import Cookies from 'js-cookie'
34
import { UnderlineNav } from '@primer/react'
45
import { sendEvent, EventType } from 'components/lib/events'
@@ -75,6 +76,7 @@ type Props = {
7576
variant?: 'subnav' | 'tabnav' | 'underlinenav'
7677
}
7778
export const ToolPicker = ({ variant = 'subnav' }: Props) => {
79+
const { asPath } = useRouter()
7880
const { defaultTool, detectedTools } = useArticleContext()
7981
const [currentTool, setCurrentTool] = useState(getDefaultTool(defaultTool, detectedTools))
8082

@@ -100,7 +102,7 @@ export const ToolPicker = ({ variant = 'subnav' }: Props) => {
100102
preserveAnchorNodePosition(document, () => {
101103
showToolSpecificContent(currentTool)
102104
})
103-
}, [currentTool])
105+
}, [currentTool, asPath])
104106

105107
function onClickTool(tool: string) {
106108
setCurrentTool(tool)

components/rest/RestOperationHeading.tsx

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ type Props = {
99
export function RestOperationHeading({ slug, title, descriptionHTML }: Props) {
1010
return (
1111
<>
12-
<h3 id={slug}>
12+
<h2 id={slug}>
1313
<a href={`#${slug}`}>
1414
<LinkIcon size={16} className="m-1" />
1515
</a>
1616
{title}
17-
</h3>
17+
</h2>
1818
<div dangerouslySetInnerHTML={{ __html: descriptionHTML }} />
1919
</>
2020
)

content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/about-your-personal-dashboard.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To access your personal dashboard once you're signed in, click the {% octicon "m
2424

2525
## Finding your recent activity
2626

27-
In the "Recent activity" section of your news feed, you can quickly find and follow up with recently updated issues and pull requests you're working on. Under "Recent activity", you can preview up to 12 recent updates made in the last two weeks.
27+
In the "Recent activity" section of your news feed, you can quickly find and follow up with recently updated issues and pull requests you're working on. Under "Recent activity", you can preview up to 4 recent updates made in the last two weeks.
2828

2929
{% data reusables.dashboard.recent-activity-qualifying-events %}
3030

content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings.md

-8
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,6 @@ You may want to use a dark theme to reduce power consumption on certain devices,
2020

2121
{% ifversion fpt or ghes > 3.2 or ghae-issue-4618 or ghec %}If you have low vision, you may benefit from a high contrast theme, with greater contrast between foreground and background elements.{% endif %}{% ifversion fpt or ghae-issue-4619 or ghec %} If you have colorblindness, you may benefit from our light and dark colorblind themes.
2222

23-
{% ifversion fpt or ghec %}
24-
{% note %}
25-
26-
**Note:** The colorblind themes are currently in public beta. For more information on enabling features in public beta, see "[Exploring early access releases with feature preview](/get-started/using-github/exploring-early-access-releases-with-feature-preview)."
27-
28-
{% endnote %}
29-
{% endif %}
30-
3123
{% endif %}
3224

3325
{% data reusables.user-settings.access_settings %}

content/actions/automating-builds-and-tests/building-and-testing-swift.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The examples below demonstrate using the `fwal/setup-swift` action.
6565

6666
### Using multiple Swift versions
6767

68-
You can configure your job to use a multiple versions of Swift in a build matrix.
68+
You can configure your job to use multiple versions of Swift in a matrix.
6969

7070
```yaml{:copy}
7171
{% data reusables.actions.actions-not-certified-by-github-comment %}

content/actions/learn-github-actions/contexts.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ miniTocMaxHeadingLevel: 3
2323

2424
Contexts are a way to access information about workflow runs, runner environments, jobs, and steps. Each context is an object that contains properties, which can be strings or other objects.
2525

26-
{% data reusables.actions.context-contents %} For example, the `matrix` context is only populated for jobs in a [build matrix](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix).
26+
{% data reusables.actions.context-contents %} For example, the `matrix` context is only populated for jobs in a [matrix](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix).
2727

2828
You can access contexts using the expression syntax. For more information, see "[Expressions](/actions/learn-github-actions/expressions)."
2929

@@ -552,19 +552,19 @@ The following example contents of the `secrets` context shows the automatic `GIT
552552

553553
## `strategy` context
554554

555-
For workflows with a build matrix, the `strategy` context contains information about the matrix execution strategy for the current job.
555+
For workflows with a matrix, the `strategy` context contains information about the matrix execution strategy for the current job.
556556

557557
| Property name | Type | Description |
558558
|---------------|------|-------------|
559559
| `strategy` | `object` | This context changes for each job in a workflow run. You can access this context from any job or step in a workflow. This object contains all the properties listed below. |
560-
| `strategy.fail-fast` | `string` | When `true`, all in-progress jobs are canceled if any job in a build matrix fails. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast)." |
561-
| `strategy.job-index` | `string` | The index of the current job in the build matrix. **Note:** This number is a zero-based number. The first job's index in the build matrix is `0`. |
562-
| `strategy.job-total` | `string` | The total number of jobs in the build matrix. **Note:** This number **is not** a zero-based number. For example, for a build matrix with four jobs, the value of `job-total` is `4`. |
560+
| `strategy.fail-fast` | `string` | When `true`, all in-progress jobs are canceled if any job in a matrix fails. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast)." |
561+
| `strategy.job-index` | `string` | The index of the current job in the matrix. **Note:** This number is a zero-based number. The first job's index in the matrix is `0`. |
562+
| `strategy.job-total` | `string` | The total number of jobs in the matrix. **Note:** This number **is not** a zero-based number. For example, for a matrix with four jobs, the value of `job-total` is `4`. |
563563
| `strategy.max-parallel` | `string` | The maximum number of jobs that can run simultaneously when using a `matrix` job strategy. For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymax-parallel)." |
564564

565565
### Example contents of the `strategy` context
566566

567-
The following example contents of the `strategy` context is from a build matrix with four jobs, and is taken from the final job. Note the difference between the zero-based `job-index` number, and `job-total` which is not zero-based.
567+
The following example contents of the `strategy` context is from a matrix with four jobs, and is taken from the final job. Note the difference between the zero-based `job-index` number, and `job-total` which is not zero-based.
568568

569569
```yaml
570570
{
@@ -577,7 +577,7 @@ The following example contents of the `strategy` context is from a build matrix
577577

578578
### Example usage of the `strategy` context
579579

580-
This example workflow uses the `strategy.job-index` property to set a unique name for a log file for each job in a build matrix.
580+
This example workflow uses the `strategy.job-index` property to set a unique name for a log file for each job in a matrix.
581581

582582
```yaml{:copy}
583583
name: Test matrix
@@ -602,18 +602,18 @@ jobs:
602602

603603
## `matrix` context
604604

605-
For workflows with a build matrix, the `matrix` context contains the matrix properties defined in the workflow file that apply to the current job. For example, if you configure a build matrix with the `os` and `node` keys, the `matrix` context object includes the `os` and `node` properties with the values that are being used for the current job.
605+
For workflows with a matrix, the `matrix` context contains the matrix properties defined in the workflow file that apply to the current job. For example, if you configure a matrix with the `os` and `node` keys, the `matrix` context object includes the `os` and `node` properties with the values that are being used for the current job.
606606

607607
There are no standard properties in the `matrix` context, only those which are defined in the workflow file.
608608

609609
| Property name | Type | Description |
610610
|---------------|------|-------------|
611-
| `matrix` | `object` | This context is only available for jobs in a build matrix, and changes for each job in a workflow run. You can access this context from any job or step in a workflow. This object contains the properties listed below. |
611+
| `matrix` | `object` | This context is only available for jobs in a matrix, and changes for each job in a workflow run. You can access this context from any job or step in a workflow. This object contains the properties listed below. |
612612
| `matrix.<property_name>` | `string` | The value of a matrix property. |
613613

614614
### Example contents of the `matrix` context
615615

616-
The following example contents of the `matrix` context is from a job in a build matrix that has the `os` and `node` matrix properties defined in the workflow. The job is executing the matrix combination of an `ubuntu-latest` OS and Node.js version `16`.
616+
The following example contents of the `matrix` context is from a job in a matrix that has the `os` and `node` matrix properties defined in the workflow. The job is executing the matrix combination of an `ubuntu-latest` OS and Node.js version `16`.
617617

618618
```yaml
619619
{
@@ -624,7 +624,7 @@ The following example contents of the `matrix` context is from a job in a build
624624

625625
### Example usage of the `matrix` context
626626

627-
This example workflow creates a build matrix with `os` and `node` keys. It uses the `matrix.os` property to set the runner type for each job, and uses the `matrix.node` property to set the Node.js version for each job.
627+
This example workflow creates a matrix with `os` and `node` keys. It uses the `matrix.os` property to set the runner type for each job, and uses the `matrix.node` property to set the Node.js version for each job.
628628

629629
```yaml{:copy}
630630
name: Test matrix

content/actions/migrating-to-github-actions/migrating-from-circleci-to-github-actions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Both CircleCI and {% data variables.product.prodname_actions %} configure `jobs`
5050

5151
Both CircleCI and {% data variables.product.prodname_actions %} provide a mechanism to reuse and share tasks in a workflow. CircleCI uses a concept called orbs, written in YAML, to provide tasks that people can reuse in a workflow. {% data variables.product.prodname_actions %} has powerful and flexible reusable components called actions, which you build with either JavaScript files or Docker images. You can create actions by writing custom code that interacts with your repository in any way you'd like, including integrating with {% data variables.product.product_name %}'s APIs and any publicly available third-party API. For example, an action can publish npm modules, send SMS alerts when urgent issues are created, or deploy production-ready code. For more information, see "[Creating actions](/actions/creating-actions)."
5252

53-
CircleCI can reuse pieces of workflows with YAML anchors and aliases. {% data variables.product.prodname_actions %} supports the most common need for reusability using build matrixes. For more information about build matrixes, see "[Managing complex workflows](/actions/learn-github-actions/managing-complex-workflows/#using-a-build-matrix)."
53+
CircleCI can reuse pieces of workflows with YAML anchors and aliases. {% data variables.product.prodname_actions %} supports the most common need for reusability using matrices. For more information about matrices, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)."
5454

5555
## Using Docker images
5656

content/actions/migrating-to-github-actions/migrating-from-jenkins-to-github-actions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,9 @@ Jenkins can run the `stages` and `steps` in parallel, while {% data variables.pr
8282
| ------------- | ------------- |
8383
| [`parallel`](https://jenkins.io/doc/book/pipeline/syntax/#parallel) | [`jobs.<job_id>.strategy.max-parallel`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idstrategymax-parallel) |
8484

85-
### Build matrix
85+
### Matrix
8686

87-
Both {% data variables.product.prodname_actions %} and Jenkins let you use a build matrix to define various system combinations.
87+
Both {% data variables.product.prodname_actions %} and Jenkins let you use a matrix to define various system combinations.
8888

8989
| Jenkins | {% data variables.product.prodname_actions %} |
9090
| ------------- | ------------- |

content/actions/migrating-to-github-actions/migrating-from-travis-ci-to-github-actions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ Travis CI can use `stages` to run jobs in parallel. Similarly, {% data variables
6060
Travis CI and {% data variables.product.prodname_actions %} both support status badges, which let you indicate whether a build is passing or failing.
6161
For more information, see ["Adding a workflow status badge to your repository](/actions/managing-workflow-runs/adding-a-workflow-status-badge)."
6262

63-
### Using a build matrix
63+
### Using a matrix
6464

65-
Travis CI and {% data variables.product.prodname_actions %} both support a build matrix, allowing you to perform testing using combinations of operating systems and software packages. For more information, see "[Using a build matrix](/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix)."
65+
Travis CI and {% data variables.product.prodname_actions %} both support a matrix, allowing you to perform testing using combinations of operating systems and software packages. For more information, see "[Using a matrix for your jobs](/actions/using-jobs/using-a-matrix-for-your-jobs)."
6666

6767
Below is an example comparing the syntax for each system:
6868

content/actions/using-jobs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ children:
1313
- /using-jobs-in-a-workflow
1414
- /choosing-the-runner-for-a-job
1515
- /using-conditions-to-control-job-execution
16-
- /using-a-build-matrix-for-your-jobs
16+
- /using-a-matrix-for-your-jobs
1717
- /using-concurrency
1818
- /using-environments-for-jobs
1919
- /running-jobs-in-a-container

content/actions/using-jobs/using-a-build-matrix-for-your-jobs.md

-30
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
---
2+
title: Using a matrix for your jobs
3+
shortTitle: Using a matrix
4+
intro: Create a matrix to define variations for each job.
5+
versions:
6+
fpt: '*'
7+
ghes: '*'
8+
ghae: '*'
9+
ghec: '*'
10+
miniTocMaxHeadingLevel: 4
11+
redirect_from:
12+
- /actions/using-jobs/using-a-build-matrix-for-your-jobs
13+
---
14+
15+
{% data reusables.actions.enterprise-beta %}
16+
{% data reusables.actions.enterprise-github-hosted-runners %}
17+
18+
## About matrix strategies
19+
20+
{% data reusables.actions.jobs.about-matrix-strategy %}
21+
22+
## Using a matrix strategy
23+
24+
{% data reusables.actions.jobs.using-matrix-strategy %}
25+
26+
### Example: Using a single-dimension matrix
27+
28+
{% data reusables.actions.jobs.single-dimension-matrix %}
29+
30+
### Example: Using a multi-dimension matrix
31+
32+
{% data reusables.actions.jobs.multi-dimension-matrix %}
33+
34+
### Example: Using contexts to create matrices
35+
36+
{% data reusables.actions.jobs.matrix-from-context %}
37+
38+
## Expanding or adding matrix configurations
39+
40+
{% data reusables.actions.jobs.matrix-include %}
41+
42+
### Example: Expanding configurations
43+
44+
{% data reusables.actions.jobs.matrix-expand-with-include %}
45+
46+
### Example: Adding configurations
47+
48+
{% data reusables.actions.jobs.matrix-add-with-include %}
49+
50+
## Excluding matrix configurations
51+
52+
{% data reusables.actions.jobs.matrix-exclude %}
53+
54+
## Handling failures
55+
56+
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-failfast %}
57+
58+
## Defining the maximum number of concurrent jobs
59+
60+
{% data reusables.actions.jobs.section-using-a-build-matrix-for-your-jobs-max-parallel %}

0 commit comments

Comments
 (0)