Skip to content

Commit 9e41e35

Browse files
authored
Merge branch 'main' into docs/add-uv-documentation
2 parents 15ef835 + bb57141 commit 9e41e35

File tree

609 files changed

+13419
-7600
lines changed

Some content is hidden

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

609 files changed

+13419
-7600
lines changed

.github/actions/slack-alert/action.yml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@ inputs:
88
slack_token:
99
description: Slack token
1010
required: true
11+
message:
12+
description: The message to send to Slack
13+
default: The last '${{ github.workflow }}' run failed. See ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
14+
required: false
15+
color:
16+
description: The color of the Slack message
17+
default: failure
18+
required: false
1119

1220
runs:
1321
using: composite
@@ -17,5 +25,5 @@ runs:
1725
with:
1826
channel: ${{ inputs.slack_channel_id }}
1927
bot-token: ${{ inputs.slack_token }}
20-
color: failure
21-
text: The last '${{ github.workflow }}' run failed. See ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
28+
color: ${{ inputs.color }}
29+
text: ${{ inputs.message }}

.github/workflows/alert-changed-branch-protections.yml

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,19 @@ jobs:
3838
id: compare
3939
run: |
4040
# Compare the fetched branch protections with the committed ones
41-
git diff --no-index .github/branch_protection_settings/${{ matrix.branch }}.json ${{ matrix.branch }}-actual.json
41+
git diff --no-index .github/branch_protection_settings/${{ matrix.branch }}.json ${{ matrix.branch }}-actual.json || echo "diff_failed=true" >> $GITHUB_ENV
42+
43+
- name: Set failure message
44+
if: env.diff_failed == 'true'
45+
run: |
46+
message="Alert due to changes in branch protections for ${{ matrix.branch }}. Please review the changes and ensure they are intentional. If valid, update the branch protection settings in .github/branch_protection_settings/${{ matrix.branch }}.json to match the diff in this workflow."
47+
echo "failure_message=$message" >> $GITHUB_ENV
48+
echo "$message"
4249
4350
- uses: ./.github/actions/slack-alert
44-
if: ${{ failure() && github.event_name != 'workflow_dispatch' }}
51+
if: ${{ env.diff_failed == 'true' && github.event_name != 'workflow_dispatch' }}
4552
with:
4653
slack_channel_id: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
4754
slack_token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
55+
message: ${{ env.failure_message }}
56+
color: purple

.github/workflows/enterprise-dates.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636

3737
- name: Create pull request
3838
id: create-pull-request
39-
uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # pin @v6.1.0
39+
uses: peter-evans/create-pull-request@6cd32fd93684475c31847837f87bb135d40a2b79 # pin @v7.0.3
4040
env:
4141
# Disable pre-commit hooks; they don't play nicely here
4242
HUSKY: '0'

.github/workflows/orphaned-assets-check.yml renamed to .github/workflows/orphaned-files-check.yml

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
name: 'Orphaned assets check'
1+
name: 'Orphaned files check'
22

3-
# **What it does**: Checks that there are no files in ./assets/ that aren't mentioned in any source file.
3+
# **What it does**: Checks that there are no files in ./assets/ and ./data/reusables that aren't mentioned in any source file.
44
# **Why we have it**: To avoid orphans into the repo.
55
# **Who does it impact**: Docs content.
66

@@ -14,6 +14,7 @@ on:
1414
# In case any of the dependencies affect the script
1515
- 'package*.json'
1616
- src/assets/scripts/find-orphaned-assets.js
17+
- src/content-render/scripts/reusables-cli/find/unused.ts
1718
- src/workflows/walk-files.js
1819
- src/languages/lib/languages.js
1920
- .github/actions/clone-translations/action.yml
@@ -44,7 +45,7 @@ jobs:
4445

4546
- uses: ./.github/actions/node-npm-setup
4647

47-
- name: Check for orphaned assets
48+
- name: Check for orphaned assets and reusables
4849
env:
4950
# Needed for gh
5051
GITHUB_TOKEN: ${{ secrets.DOCS_BOT_PAT_READPUBLICKEY }}
@@ -54,10 +55,16 @@ jobs:
5455
5556
# The `-s` is to make npm run silent and not print verbose
5657
# information about the npm script alias.
57-
filesToRemove=`npm run -s find-orphaned-assets`
58-
[ -z "$filesToRemove" ] && exit 0
58+
assetFilesToRemove=$(npm run -s find-orphaned-assets)
59+
reusableFilesToRemove=$(npm run -s reusables -- find unused | grep '^data/reusables')
60+
[ -z "$assetFilesToRemove" ] && [ -z "$reusableFilesToRemove" ] && exit 0
5961
60-
echo $filesToRemove | xargs git rm
62+
if [ -n "$assetFilesToRemove" ]; then
63+
echo $assetFilesToRemove | xargs git rm
64+
fi
65+
if [ -n "$reusableFilesToRemove" ]; then
66+
echo $reusableFilesToRemove | xargs git rm
67+
fi
6168
6269
git status
6370
@@ -76,25 +83,26 @@ jobs:
7683
git config --global user.email "77750099+docs-bot@users.noreply.github.com"
7784
7885
date=$(date '+%Y-%m-%d-%H-%M')
79-
branchname=orphaned-assets-$date-$GITHUB_RUN_ID
86+
branchname=orphaned-files-$date-$GITHUB_RUN_ID
8087
8188
git checkout -b $branchname
82-
git commit -m "Delete orphaned assets $date"
89+
git commit -m "Delete orphaned files $date"
8390
git push origin $branchname
8491
8592
body=$(cat <<-EOM
8693
Found with the npm run find-orphaned-assets script.
87-
The orphaned assets workflow file .github/workflows/orphaned-assets-check.yml
94+
The orphaned files workflow file .github/workflows/orphaned-files-check.yml
8895
runs every Monday at 16:20 UTC / 8:20 PST.
8996
The first responder should just spot-check some of the unused assets
9097
to make sure they aren't referenced anywhere
9198
and then approve and merge the pull request.
92-
For more information, see [Doc: Orphaned Assets](https://github.com/github/docs-engineering/blob/main/docs/orphaned-assets.md).
99+
For more information, see [Doc: Orphaned Assets](https://github.com/github/docs-engineering/blob/main/docs/orphaned-assets.md)
100+
and [Doc: Reusables CLI](https://github.com/github/docs-internal/tree/main/src/content-render/scripts/reusables-cli).
93101
EOM
94102
)
95103
96104
gh pr create \
97-
--title "Delete orphaned assets ($date)" \
105+
--title "Delete orphaned files ($date)" \
98106
--body "$body" \
99107
--repo github/docs-internal \
100108
--label docs-content-fr

.github/workflows/sync-graphql.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ jobs:
2929
src/graphql/scripts/sync.js
3030
- name: Create pull request
3131
id: create-pull-request
32-
uses: peter-evans/create-pull-request@c5a7806660adbe173f04e3e038b0ccdcd758773c # pin @v6.1.0
32+
uses: peter-evans/create-pull-request@6cd32fd93684475c31847837f87bb135d40a2b79 # pin @v7.0.3
3333
env:
3434
# Disable pre-commit hooks; they don't play nicely here
3535
HUSKY: '0'

.github/workflows/test.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ jobs:
6666
- observability
6767
# - open-source
6868
- pageinfo
69+
- pagelist
6970
# - pages
7071
- products
7172
- redirects
Loading

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-access-to-your-personal-accounts-project-boards.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@ redirect_from:
1010
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-access-to-your-user-accounts-project-boards
1111
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-access-to-your-personal-accounts-project-boards
1212
versions:
13-
fpt: '*'
14-
ghes: '*'
15-
ghec: '*'
13+
feature: projects-v1
1614
topics:
1715
- Accounts
1816
shortTitle: 'Manage {% data variables.projects.projects_v1_boards %} access'

content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@ redirect_from:
88
- /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/permission-levels-for-user-owned-project-boards
99
- /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-project-board-owned-by-a-personal-account
1010
versions:
11-
fpt: '*'
12-
ghes: '*'
13-
ghec: '*'
11+
feature: projects-v1
1412
topics:
1513
- Accounts
1614
shortTitle: '{% data variables.projects.projects_v1_board_caps %} permissions'

content/actions/about-github-actions/about-continuous-integration-with-github-actions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ For a definition of common terms, see "[AUTOTITLE](/actions/learn-github-actions
4747

4848
{% data variables.product.product_name %} offers CI workflow templates for a variety of languages and frameworks.
4949

50-
Browse the complete list of CI workflow templates offered by {% data variables.product.company_short %} in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.location.product_location %}{% endif %}.
50+
Browse the complete list of CI workflow templates offered by {% data variables.product.company_short %} in the {% ifversion fpt or ghec %}[actions/starter-workflows](https://github.com/actions/starter-workflows/tree/main/ci) repository{% else %} `actions/starter-workflows` repository on {% data variables.product.prodname_dotcom_the_website %}{% endif %}.
5151

5252
## Further reading
5353

0 commit comments

Comments
 (0)