Skip to content

Commit 799f2a5

Browse files
authored
Merge branch 'main' into imjohnbo-content-plan-6764
2 parents 6051363 + 6e96f3a commit 799f2a5

File tree

701 files changed

+199110
-10843
lines changed

Some content is hidden

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

701 files changed

+199110
-10843
lines changed

.github/workflows/check-all-english-links.yml

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ jobs:
1717
check_all_english_links:
1818
name: Check all links
1919
if: github.repository == 'github/docs-internal'
20-
runs-on: ${{ fromJSON('["ubuntu-latest", "self-hosted"]')[github.repository == 'github/docs-internal'] }}
20+
runs-on: self-hosted
2121
env:
2222
GITHUB_TOKEN: ${{ secrets.DOCUBOT_READORG_REPO_WORKFLOW_SCOPES }}
2323
FIRST_RESPONDER_PROJECT: Docs content first responder
@@ -56,9 +56,8 @@ jobs:
5656
# The default is 10s. But because this runs overnight, we can
5757
# be a lot more patient.
5858
REQUEST_TIMEOUT: 20000
59-
# The default is 300 which works OK on a fast macbook pro
60-
# but so well in Actions.
61-
LINKINATOR_CONCURRENCY: 100
59+
# Don't care about CDN caching image URLs
60+
DISABLE_REWRITE_ASSET_URLS: true
6261
run: |
6362
node server.mjs > /tmp/stdout.log 2> /tmp/stderr.log &
6463
sleep 5
@@ -73,6 +72,10 @@ jobs:
7372
cat /tmp/stderr.log
7473
7574
- name: Run script
75+
env:
76+
# The default is 300 which works OK on a fast macbook pro
77+
# but not so well in Actions.
78+
LINKINATOR_CONCURRENCY: 100
7679
run: |
7780
script/check-english-links.js > broken_links.md
7881
@@ -84,11 +87,6 @@ jobs:
8487
#
8588
# https://docs.github.com/actions/reference/context-and-expression-syntax-for-github-actions#job-status-check-functions
8689

87-
- if: ${{ failure() }}
88-
name: Debug broken_links.md
89-
run: |
90-
ls -lh broken_links.md
91-
wc -l broken_links.md
9290
- uses: actions/upload-artifact@6673cd052c4cd6fcf4b4e6e60ea986c889389535
9391
if: ${{ failure() }}
9492
with:

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,9 @@ jobs:
4949
run: cat $HOME/files.json
5050

5151
- name: Link check (warnings, changed files)
52+
env:
53+
# Don't care about CDN caching image URLs
54+
DISABLE_REWRITE_ASSET_URLS: true
5255
run: |
5356
./script/rendered-content-link-checker.mjs \
5457
--language en \
@@ -59,6 +62,9 @@ jobs:
5962
--list $HOME/files.json
6063
6164
- name: Link check (critical, all files)
65+
env:
66+
# Don't care about CDN caching image URLs
67+
DISABLE_REWRITE_ASSET_URLS: true
6268
run: |
6369
./script/rendered-content-link-checker.mjs \
6470
--language en \
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Binary file not shown.
Loading
Loading
Loading
71.5 KB
Loading
Loading

components/rest/ParameterRow.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export function ParameterRow({
5555
</a>
5656
)}
5757
<div className="pt-2">
58-
{defaultValue && (
58+
{defaultValue !== undefined && (
5959
<p>
6060
<span>{t('rest.reference.default')}: </span>
6161
<code>{defaultValue.toString()}</code>

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ For web-based Git operations, you can set your commit email address on {% ifvers
4141

4242
{% endif %}
4343

44-
{% ifversion fpt or ghec %}If you'd like to keep your personal email address private, you can use a `no-reply` email address from {% data variables.product.product_name %} as your commit email address. To use your `noreply` email address for commits you push from the command line, use that email address when you set your commit email address in Git. To use your `noreply` address for web-based Git operations, set your commit email address on GitHub and choose to **Keep my email address private**.
44+
{% ifversion fpt or ghec %}If you'd like to keep your personal email address private, you can use a `noreply` email address from {% data variables.product.product_name %} as your commit email address. To use your `noreply` email address for commits you push from the command line, use that email address when you set your commit email address in Git. To use your `noreply` address for web-based Git operations, set your commit email address on GitHub and choose to **Keep my email address private**.
4545

4646
You can also choose to block commits you push from the command line that expose your personal email address. For more information, see "[Blocking command line pushes that expose your personal email](/articles/blocking-command-line-pushes-that-expose-your-personal-email-address)."{% endif %}
4747

@@ -51,7 +51,7 @@ To ensure that commits are attributed to you and appear in your contributions gr
5151

5252
{% note %}
5353

54-
**Note:** If you created your account on {% data variables.product.product_location %} _after_ July 18, 2017, your `no-reply` email address for {% data variables.product.product_name %} is a seven-digit ID number and your username in the form of <code><em>ID+username</em>@users.noreply.github.com</code>. If you created your account on {% data variables.product.product_location %} _prior to_ July 18, 2017, your `no-reply` email address from {% data variables.product.product_name %} is <code><em>username</em>@users.noreply.github.com</code>. You can get an ID-based `no-reply` email address for {% data variables.product.product_name %} by selecting (or deselecting and reselecting) **Keep my email address private** in your email settings.
54+
**Note:** If you created your account on {% data variables.product.product_location %} _after_ July 18, 2017, your `noreply` email address for {% data variables.product.product_name %} is a seven-digit ID number and your username in the form of <code><em>ID+username</em>@users.noreply.github.com</code>. If you created your account on {% data variables.product.product_location %} _prior to_ July 18, 2017, your `noreply` email address from {% data variables.product.product_name %} is <code><em>username</em>@users.noreply.github.com</code>. You can get an ID-based `noreply` email address for {% data variables.product.product_name %} by selecting (or deselecting and reselecting) **Keep my email address private** in your email settings.
5555

5656
{% endnote %}
5757

content/actions/deployment/security-hardening-your-deployments/using-openid-connect-with-reusable-workflows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ redirect_from:
77
- /actions/deployment/security-hardening-your-deployments/using-oidc-with-your-reusable-workflows
88
versions:
99
fpt: '*'
10-
ghae: issue-4757-and-5856
10+
ghae: issue-4757
1111
ghec: '*'
1212
ghes: '>=3.5'
1313
type: how_to

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

Lines changed: 43 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ You can access contexts using the expression syntax. For more information, see "
4545
| `matrix` | `object` | Contains the matrix properties defined in the workflow that apply to the current job. For more information, see [`matrix` context](#matrix-context). |
4646
| `needs` | `object` | Contains the outputs of all jobs that are defined as a dependency of the current job. For more information, see [`needs` context](#needs-context). |
4747
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %}
48-
| `inputs` | `object` | Contains the inputs of a reusable workflow. For more information, see [`inputs` context](#inputs-context). |{% endif %}
48+
| `inputs` | `object` | Contains the inputs of a reusable {% ifversion actions-unified-inputs %}or manually triggered {% endif %}workflow. For more information, see [`inputs` context](#inputs-context). |{% endif %}
4949

5050
As part of an expression, you can access context information using one of two syntaxes.
5151

@@ -193,7 +193,7 @@ The `github` context contains information about the workflow run and the event t
193193
| `github.graphql_url` | `string` | The URL of the {% data variables.product.prodname_dotcom %} GraphQL API. |
194194
| `github.head_ref` | `string` | The `head_ref` or source branch of the pull request in a workflow run. This property is only available when the event that triggers a workflow run is either `pull_request` or `pull_request_target`. |
195195
| `github.job` | `string` | The [`job_id`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_id) of the current job. <br /> Note: This context property is set by the Actions runner, and is only available within the execution `steps` of a job. Otherwise, the value of this property will be `null`. |
196-
| `github.ref` | `string` | The branch or tag ref that triggered the workflow run. For branches this is the format `refs/heads/<branch_name>`, and for tags it is `refs/tags/<tag_name>`. |
196+
| `github.ref` | `string` | {% data reusables.actions.ref-description %} |
197197
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5338 %}
198198
| `github.ref_name` | `string` | {% data reusables.actions.ref_name-description %} |
199199
| `github.ref_protected` | `string` | {% data reusables.actions.ref_protected-description %} |
@@ -714,33 +714,32 @@ jobs:
714714
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-4757 %}
715715
## `inputs` context
716716

717-
The `inputs` context contains input properties passed to a reusable workflow. The input names and types are defined in the [`workflow_call` event configuration](/actions/learn-github-actions/events-that-trigger-workflows#workflow-reuse-events) of a reusable workflow, and the input values are passed from [`jobs.<job_id>.with`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idwith) in an external workflow that calls the reusable workflow.
717+
The `inputs` context contains input properties passed to a reusable workflow{% ifversion actions-unified-inputs %} or to a manually triggered workflow{% endif %}. {% ifversion actions-unified-inputs %}For reusable workflows, the{% else %}The{% endif %} input names and types are defined in the [`workflow_call` event configuration](/actions/learn-github-actions/events-that-trigger-workflows#workflow-reuse-events) of a reusable workflow, and the input values are passed from [`jobs.<job_id>.with`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idwith) in an external workflow that calls the reusable workflow. {% ifversion actions-unified-inputs %}For manually triggered workflows, the inputs are defined in the [`workflow_dispatch` event configuration](/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch) of a workflow.{% endif %}
718718

719-
There are no standard properties in the `inputs` context, only those which are defined in the reusable workflow file.
719+
There are no standard properties in the `inputs` context, only those which are defined in the workflow file.
720720

721721
{% data reusables.actions.reusable-workflows-ghes-beta %}
722722

723-
For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)".
724-
725723
| Property name | Type | Description |
726724
|---------------|------|-------------|
727-
| `inputs` | `object` | This context is only available in a [reusable workflow](/actions/learn-github-actions/reusing-workflows). You can access this context from any job or step in a workflow. This object contains the properties listed below. |
725+
| `inputs` | `object` | This context is only available in a [reusable workflow](/actions/learn-github-actions/reusing-workflows){% ifversion actions-unified-inputs %} or in a workflow triggered by the [`workflow_dispatch` event](/actions/learn-github-actions/events-that-trigger-workflows#workflow_dispatch){% endif %}. You can access this context from any job or step in a workflow. This object contains the properties listed below. |
728726
| `inputs.<name>` | `string` or `number` or `boolean` | Each input value passed from an external workflow. |
729727

730728
### Example contents of the `inputs` context
731729

732-
The following example contents of the `inputs` context is from a job in a reusable workflow that has defined the `build_id` and `deploy_target` inputs.
730+
The following example contents of the `inputs` context is from a workflow that has defined the `build_id`, `deploy_target`, and `perform_deploy` inputs.
733731

734732
```yaml
735733
{
736734
"build_id": 123456768,
737-
"deploy_target": "deployment_sys_1a"
735+
"deploy_target": "deployment_sys_1a",
736+
"perform_deploy": true
738737
}
739738
```
740739

741-
### Example usage of the `inputs` context
740+
### Example usage of the `inputs` context in a reusable workflow
742741

743-
This example reusable workflow uses the `inputs` context to get the values of the `build_id` and `deploy_target` inputs that were passed to the reusable workflow from the caller workflow.
742+
This example reusable workflow uses the `inputs` context to get the values of the `build_id`, `deploy_target`, and `perform_deploy` inputs that were passed to the reusable workflow from the caller workflow.
744743

745744
{% raw %}
746745
```yaml{:copy}
@@ -761,10 +760,42 @@ on:
761760
jobs:
762761
deploy:
763762
runs-on: ubuntu-latest
764-
if: ${{ inputs.perform_deploy == 'true' }}
763+
if: ${{ inputs.perform_deploy }}
764+
steps:
765+
- name: Deploy build to target
766+
run: deploy --build ${{ inputs.build_id }} --target ${{ inputs.deploy_target }}
767+
```
768+
{% endraw %}
769+
770+
{% ifversion actions-unified-inputs %}
771+
### Example usage of the `inputs` context in a manually triggered workflow
772+
773+
This example workflow triggered by a `workflow_dispatch` event uses the `inputs` context to get the values of the `build_id`, `deploy_target`, and `perform_deploy` inputs that were passed to the workflow.
774+
775+
{% raw %}
776+
```yaml{:copy}
777+
on:
778+
workflow_dispatch:
779+
inputs:
780+
build_id:
781+
required: true
782+
type: string
783+
deploy_target:
784+
required: true
785+
type: string
786+
perform_deploy:
787+
required: true
788+
type: boolean
789+
790+
jobs:
791+
deploy:
792+
runs-on: ubuntu-latest
793+
if: ${{ inputs.perform_deploy }}
765794
steps:
766795
- name: Deploy build to target
767796
run: deploy --build ${{ inputs.build_id }} --target ${{ inputs.deploy_target }}
768797
```
769798
{% endraw %}
770799
{% endif %}
800+
801+
{% endif %}

content/actions/learn-github-actions/environment-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ We strongly recommend that actions use environment variables to access the files
143143
| `GITHUB_HEAD_REF` | The head ref or source branch of the pull request in a workflow run. This property is only set when the event that triggers a workflow run is either `pull_request` or `pull_request_target`. For example, `feature-branch-1`. |
144144
| `GITHUB_JOB` | The [job_id](/actions/reference/workflow-syntax-for-github-actions#jobsjob_id) of the current job. For example, `greeting_job`. |
145145
| `GITHUB_PATH` | The path on the runner to the file that sets system `PATH` variables from workflow commands. This file is unique to the current step and changes for each step in a job. For example, `/home/runner/work/_temp/_runner_file_commands/add_path_899b9445-ad4a-400c-aa89-249f18632cf5`. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/using-workflows/workflow-commands-for-github-actions#adding-a-system-path)." |
146-
| `GITHUB_REF` | The branch or tag ref that triggered the workflow run. For branches this is the format `refs/heads/<branch_name>`, for tags it is `refs/tags/<tag_name>`, and for pull requests it is `refs/pull/<pr_number>/merge`. This variable is only set if a branch or tag is available for the event type. For example, `refs/heads/feature-branch-1`. |
146+
| `GITHUB_REF` | {% data reusables.actions.ref-description %} |
147147
{%- ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5338 %}
148148
| `GITHUB_REF_NAME` | {% data reusables.actions.ref_name-description %} For example, `feature-branch-1`.|
149149
| `GITHUB_REF_PROTECTED` | {% data reusables.actions.ref_protected-description %} |

content/actions/managing-workflow-runs/removing-workflow-artifacts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ shortTitle: Remove workflow artifacts
1616

1717
{% warning %}
1818

19-
**Warning:** Once you delete an artifact, it can not be restored.
19+
**Warning:** Once you delete an artifact, it cannot be restored.
2020

2121
{% endwarning %}
2222

content/actions/using-workflows/events-that-trigger-workflows.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1250,12 +1250,13 @@ on: workflow_dispatch
12501250

12511251
#### Providing inputs
12521252

1253-
You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow. When you trigger the event, you can provide the `ref` and any `inputs`. When the workflow runs, you can access the input values in the `github.event.inputs` context. For more information, see "[Contexts](/actions/learn-github-actions/contexts)."
1253+
You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow. When you trigger the event, you can provide the `ref` and any `inputs`. When the workflow runs, you can access the input values in the {% ifversion actions-unified-inputs %}`inputs`{% else %}`github.event.inputs`{% endif %} context. For more information, see "[Contexts](/actions/learn-github-actions/contexts)."
1254+
1255+
{% data reusables.actions.inputs-vs-github-event-inputs %}
12541256

12551257
{% ifversion fpt or ghec or ghes > 3.3 or ghae-issue-5511 %}
1256-
This example defines inputs called `logLevel`, `tags`, and `environment`. You pass values for these inputs to the workflow when you run it. This workflow then prints the values to the log, using the `github.event.inputs.logLevel`, `github.event.inputs.tags`, and `github.event.inputs.environment` context properties.
1258+
This example defines inputs called `logLevel`, `tags`, and `environment`. You pass values for these inputs to the workflow when you run it. This workflow then prints the values to the log, using the {% ifversion actions-unified-inputs %}`inputs.logLevel`, `inputs.tags`, and `inputs.environment`{% else %}`github.event.inputs.logLevel`, `github.event.inputs.tags`, and `github.event.inputs.environment`{% endif %} context properties.
12571259

1258-
{% raw %}
12591260
```yaml
12601261
on:
12611262
workflow_dispatch:
@@ -1287,11 +1288,10 @@ jobs:
12871288
echo "Tags: $TAGS"
12881289
echo "Environment: $ENVIRONMENT"
12891290
env:
1290-
LEVEL: ${{ github.event.inputs.logLevel }}
1291-
TAGS: ${{ github.event.inputs.tags }}
1292-
ENVIRONMENT: ${{ github.event.inputs.environment }}
1291+
LEVEL: {% ifversion actions-unified-inputs %}{% raw %}${{ inputs.logLevel }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.logLevel }}{% endraw %}{% endif %}
1292+
TAGS: {% ifversion actions-unified-inputs %}{% raw %}${{ inputs.tags }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.tags }}{% endraw %}{% endif %}
1293+
ENVIRONMENT: {% ifversion actions-unified-inputs %}{% raw %}${{ inputs.environment }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.environment }}{% endraw %}{% endif %}
12931294
```
1294-
{% endraw %}
12951295

12961296
If you run this workflow from a browser you must enter values for the required inputs manually before the workflow will run.
12971297

@@ -1306,7 +1306,7 @@ gh workflow run run-tests.yml -f logLevel=warning -f tags=false -f environment=s
13061306
For more information, see the {% data variables.product.prodname_cli %} information in "[Manually running a workflow](/actions/managing-workflow-runs/manually-running-a-workflow)."
13071307

13081308
{% else %}
1309-
This example defines the `name` and `home` inputs and prints them using the `github.event.inputs.name` and `github.event.inputs.home` contexts. If a `home` isn't provided, the default value 'The Octoverse' is printed.
1309+
This example defines the `name` and `home` inputs and prints them using the {% ifversion actions-unified-inputs %}`inputs.name` and `inputs.home`{% else %}`github.event.inputs.name` and `github.event.inputs.home`{% endif %} contexts. If a `home` isn't provided, the default value 'The Octoverse' is printed.
13101310

13111311
```yaml
13121312
name: Manually triggered workflow
@@ -1330,8 +1330,8 @@ jobs:
13301330
echo Hello $NAME!
13311331
echo -in $HOME
13321332
env:
1333-
NAME: {% raw %}${{ github.event.inputs.name }}{% endraw %}
1334-
HOME: {% raw %}${{ github.event.inputs.home }}{% endraw %}
1333+
NAME: {% ifversion actions-unified-inputs %}{% raw %}${{ inputs.name }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.name }}{% endraw %}{% endif %}
1334+
HOME: {% ifversion actions-unified-inputs %}{% raw %}${{ github.event.inputs.home }}{% endraw %}{% else %}{% raw %}${{ github.event.inputs.home }}{% endraw %}{% endif %}
13351335
```
13361336
{% endif %}
13371337

content/admin/code-security/managing-supply-chain-security-for-your-enterprise/enabling-the-dependency-graph-for-your-enterprise.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ If your {% data variables.product.product_location %} uses clustering, you canno
5050
```{% endif %}
5151
{% note %}
5252
53-
**Note**: For more information about enabling access to the administrative shell via SSH, see "[Accessing the administrative shell (SSH)](/enterprise/{{ currentVersion }}/admin/configuration/accessing-the-administrative-shell-ssh)."
53+
**Note**: For more information about enabling access to the administrative shell via SSH, see "[Accessing the administrative shell (SSH)](/enterprise/admin/configuration/accessing-the-administrative-shell-ssh)."
5454
5555
{% endnote %}
5656
2. Apply the configuration.

0 commit comments

Comments
 (0)