Skip to content

Commit 42dd7ac

Browse files
authored
Merge branch 'main' into main
2 parents 2b9aa95 + e6d7d66 commit 42dd7ac

248 files changed

Lines changed: 372469 additions & 188955 deletions

File tree

Some content is hidden

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

.github/instructions/content.instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
applyTo: "content/**,data/**,**/*.md"
2+
applyTo: "content/**,data/**"
33
---
44

55
# Copilot content instructions for docs.github.com

.github/instructions/style-guide-summary.instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
applyTo: "content/**,data/**,**/*.md"
2+
applyTo: "content/**,data/**"
33
---
44

55
# Concise style guide for docs.github.com

.github/workflows/enterprise-dates.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
app-id: ${{ secrets.DOCS_BOT_APP_ID }}
3333
private-key: ${{ secrets.DOCS_BOT_APP_PRIVATE_KEY }}
3434
owner: github
35-
repositories: docs-internal,docs-engineering
35+
repositories: docs-internal,docs-engineering,enterprise-releases
3636

3737
- uses: ./.github/actions/node-npm-setup
3838

.github/workflows/enterprise-release-issue.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ jobs:
2727
app-id: ${{ secrets.DOCS_BOT_APP_ID }}
2828
private-key: ${{ secrets.DOCS_BOT_APP_PRIVATE_KEY }}
2929
owner: github
30-
repositories: docs-content,docs-engineering
30+
repositories: docs-content,docs-engineering,enterprise-releases
3131

3232
- uses: ./.github/actions/node-npm-setup
3333

.github/workflows/line-endings.yml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: Line endings
2+
3+
# **What it does**: Fails if any committed file violates the repo's `.gitattributes`
4+
# line-ending rules (for example, CRLF in a file declared `eol=lf`).
5+
# **Why we have it**: `.gitattributes` (`*.md text eol=lf`, `* text=auto`) only
6+
# normalizes line endings during a local `git add`/checkout. A server-side
7+
# squash-merge can commit CRLF blobs that bypass it. A file with mixed line endings
8+
# then shows as permanently "modified" on Linux runners, which breaks PR-creating
9+
# sync workflows that use peter-evans/create-pull-request. See
10+
# github/docs-engineering#6657 and github/docs-engineering#6656.
11+
# **Who does it impact**: Docs engineering, open-source engineering contributors.
12+
13+
on:
14+
workflow_dispatch:
15+
merge_group:
16+
pull_request:
17+
18+
permissions:
19+
contents: read
20+
21+
# This allows a subsequently queued workflow run to interrupt previous runs
22+
concurrency:
23+
group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
24+
cancel-in-progress: true
25+
26+
jobs:
27+
line-endings:
28+
if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Check out repo
32+
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
33+
34+
- name: Check line endings
35+
# Re-stage every file through the `.gitattributes` filters and fail if any
36+
# committed blob disagrees with them (usually CRLF where LF is required).
37+
run: |
38+
git add --renormalize .
39+
if ! git diff --cached --quiet; then
40+
echo "::error::These files violate .gitattributes line-ending rules (usually CRLF that should be LF):"
41+
git diff --cached --name-only
42+
echo ""
43+
echo "Fix locally with: git add --renormalize . && git commit"
44+
exit 1
45+
fi

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,15 +61,6 @@ jobs:
6161
run: |
6262
if [ -f "artifacts/external-link-report.md" ]; then
6363
echo "has_report=true" >> $GITHUB_OUTPUT
64-
# Prepend disclaimer banner
65-
tmp=$(mktemp)
66-
{
67-
echo "> [!NOTE]"
68-
echo "> **No action needed right now.** The link checker is being actively worked on and may produce false positives. You can safely ignore this report for now. We'll let you know when it's reliable."
69-
echo ""
70-
cat "artifacts/external-link-report.md"
71-
} > "$tmp"
72-
mv "$tmp" "artifacts/external-link-report.md"
7364
else
7465
echo "has_report=false" >> $GITHUB_OUTPUT
7566
echo "No broken link report generated - all links valid!"

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@ jobs:
5555
curl --retry-connrefused --retry 5 -I http://localhost:4000/
5656
5757
- name: Run broken github/github link check
58+
env:
59+
# Needs a token with access to github/github; the app token is scoped to it above
60+
GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
5861
run: |
5962
npm run check-github-github-links -- broken_github_github_links.md
6063

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

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,9 +248,6 @@ jobs:
248248
# Combine all markdown reports
249249
echo "# Internal Links Report" > combined-report.md
250250
echo "" >> combined-report.md
251-
echo "> [!NOTE]" >> combined-report.md
252-
echo "> **No action needed right now.** The link checker is being actively worked on and may produce false positives. You can safely ignore this report for now. We'll let you know when it's reliable." >> combined-report.md
253-
echo "" >> combined-report.md
254251
echo "Generated: $(date -u +'%Y-%m-%d %H:%M UTC')" >> combined-report.md
255252
echo "[Action run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }})" >> combined-report.md
256253
echo "" >> combined-report.md

.github/workflows/link-check-on-pr.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
workflow_dispatch:
99
# merge_group:
1010
pull_request:
11-
types: [labeled, opened, synchronize, reopened]
11+
types: [opened, synchronize, reopened]
1212

1313
permissions:
1414
contents: read
@@ -24,9 +24,7 @@ jobs:
2424
check-links:
2525
name: Check links
2626
runs-on: ubuntu-latest
27-
if: |
28-
(github.repository == 'github/docs-internal' || github.repository == 'github/docs') &&
29-
(github.event_name == 'workflow_dispatch' || contains(github.event.pull_request.labels.*.name, 'check-links'))
27+
if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
3028
steps:
3129
- name: Checkout
3230
uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6.0.1
@@ -61,12 +59,14 @@ jobs:
6159
6260
- name: Check links in changed files
6361
if: steps.changed-files.outputs.any_changed == 'true'
62+
# Work in progress: never fail the PR. The comment is informational only.
63+
continue-on-error: true
6464
env:
6565
FILES_CHANGED: ${{ steps.changed-files.outputs.all_changed_files }}
6666
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6767
ACTION_RUN_URL: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
6868
SHOULD_COMMENT: ${{ secrets.DOCS_BOT_APP_ID != '' }}
69-
FAIL_ON_FLAW: true
69+
FAIL_ON_FLAW: false
7070
ENABLED_LANGUAGES: en
7171
run: npm run check-links-pr
7272

.github/workflows/sync-sdk-docs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ on:
2424
types: [opened, synchronize, reopened]
2525
paths:
2626
- '.github/workflows/sync-sdk-docs.yml'
27-
- 'src/scripts/sync-sdk-docs/**'
27+
- 'src/workflows/sync-sdk-docs/**'
2828

2929
concurrency:
3030
group: sync-sdk-docs-${{ github.event_name }}
@@ -88,7 +88,7 @@ jobs:
8888
8989
- name: Normalize content
9090
run: |
91-
npx tsx src/scripts/sync-sdk-docs/normalize-sdk-docs.ts \
91+
npx tsx src/workflows/sync-sdk-docs/normalize-sdk-docs.ts \
9292
--content-dir content \
9393
--sdk-docs-dir "$SDK_DOCS_TARGET"
9494
@@ -98,7 +98,7 @@ jobs:
9898
run: |
9999
# Puppeteer needs --no-sandbox on GitHub Actions runners
100100
echo '{ "args": ["--no-sandbox", "--disable-setuid-sandbox"] }' > /tmp/puppeteer-config.json
101-
npx tsx src/scripts/sync-sdk-docs/convert-mermaid.ts \
101+
npx tsx src/workflows/sync-sdk-docs/convert-mermaid.ts \
102102
--sdk-docs-dir "$SDK_DOCS_TARGET" \
103103
--assets-dir "$ASSETS_TARGET" \
104104
--repo-root . \

0 commit comments

Comments
 (0)