Skip to content

Commit e5a7d7a

Browse files
authored
Merge branch 'main' into main
2 parents 74595f6 + 2bbba3c commit e5a7d7a

File tree

1,599 files changed

+227397
-133703
lines changed

Some content is hidden

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

1,599 files changed

+227397
-133703
lines changed

.github/workflows/readability.yml

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
name: Readability report
2+
3+
# **What it does**: Analyzes readability of rendered content for changed Markdown files in pull requests
4+
# **Why we have it**: We want to track and improve the readability of our documentation over time
5+
# **Who does it impact**: Contributors and content writers
6+
7+
on:
8+
# pull_request:
9+
# paths:
10+
# - 'content/**/*.md'
11+
# - 'data/reusables/**/*.md'
12+
# The pull_request trigger is currently disabled for testing purposes.
13+
# Re-enable this trigger when ready to run readability analysis automatically on PRs.
14+
workflow_dispatch:
15+
inputs:
16+
pull_request_number:
17+
description: 'Pull request number to analyze (for testing)'
18+
required: true
19+
type: number
20+
21+
permissions:
22+
contents: read
23+
pull-requests: write
24+
25+
jobs:
26+
readability-analysis:
27+
if: github.repository == 'github/docs-internal'
28+
runs-on: ${{ fromJSON('["ubuntu-latest", "ubuntu-20.04-xl"]')[github.repository == 'github/docs-internal'] }}
29+
steps:
30+
- name: Check out repo with full history
31+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
32+
with:
33+
fetch-depth: 0
34+
35+
- name: Checkout PR for manual dispatch
36+
if: ${{ github.event_name == 'workflow_dispatch' }}
37+
run: |
38+
gh pr checkout ${{ inputs.pull_request_number }}
39+
env:
40+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
41+
42+
- uses: ./.github/actions/node-npm-setup
43+
44+
- uses: ./.github/actions/get-docs-early-access
45+
if: ${{ github.repository == 'github/docs-internal' }}
46+
with:
47+
token: ${{ secrets.DOCS_BOT_PAT_BASE }}
48+
49+
- name: Get changed content files
50+
id: changed_files
51+
uses: ./.github/actions/get-changed-files
52+
with:
53+
files: 'content/**/*.md'
54+
# For workflow_dispatch, compare against main
55+
base: ${{ github.event_name == 'workflow_dispatch' && 'main' || '' }}
56+
57+
- name: Disable Next.js telemetry
58+
run: npx next telemetry disable
59+
60+
- name: Start server in the background
61+
if: ${{ steps.changed_files.outputs.filtered_changed_files }}
62+
run: npm start > /tmp/stdout.log 2> /tmp/stderr.log &
63+
64+
- name: Run readability analysis
65+
if: ${{ steps.changed_files.outputs.filtered_changed_files }}
66+
env:
67+
CHANGED_FILES: ${{ steps.changed_files.outputs.filtered_changed_files }}
68+
run: npm run readability-report
69+
70+
- name: Find existing readability comment
71+
if: ${{ steps.changed_files.outputs.filtered_changed_files }}
72+
uses: peter-evans/find-comment@3eae4d37986fb5a8592848f6a574fdf654e61f9e
73+
id: findComment
74+
with:
75+
issue-number: ${{ github.event_name == 'workflow_dispatch' && inputs.pull_request_number || github.event.number }}
76+
comment-author: 'github-actions[bot]'
77+
body-includes: '<!-- READABILITY_REPORT -->'
78+
79+
- name: Read readability report
80+
if: ${{ steps.changed_files.outputs.filtered_changed_files }}
81+
id: read_report
82+
run: |
83+
if [ -f "readability-report.md" ]; then
84+
{
85+
echo 'report<<EOF'
86+
cat readability-report.md
87+
echo EOF
88+
} >> "$GITHUB_OUTPUT"
89+
fi
90+
91+
- name: Create or update readability comment
92+
if: ${{ steps.changed_files.outputs.filtered_changed_files && steps.read_report.outputs.report }}
93+
uses: peter-evans/create-or-update-comment@71345be0265236311c031f5c7866368bd1eff043
94+
with:
95+
comment-id: ${{ steps.findComment.outputs.comment-id }}
96+
issue-number: ${{ github.event_name == 'workflow_dispatch' && inputs.pull_request_number || github.event.number }}
97+
body: |
98+
<!-- READABILITY_REPORT -->
99+
${{ steps.read_report.outputs.report }}
100+
edit-mode: replace
101+
102+
- if: ${{ failure() }}
103+
name: Debug server outputs on errors
104+
run: |
105+
echo "____STDOUT____"
106+
cat /tmp/stdout.log || echo "No stdout log found"
107+
echo "____STDERR____"
108+
cat /tmp/stderr.log || echo "No stderr log found"

.nvmrc

Whitespace-only changes.

CHANGELOG.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
11
# Docs changelog
22

3+
**4 August 2025**
4+
5+
To address common pain points that developers face when remediating a leaked secret, we created a new article, "[Remediating a leaked secret](https://docs.github.com/en/code-security/secret-scanning/working-with-secret-scanning-and-push-protection/remediating-a-leaked-secret)".
6+
7+
The new guide incorporates cross-platform GitHub tools, as well as opinionated guidance from GitHub's secret scanning team, to walk the developer through a thorough remediation process.
8+
9+
It also clearly communicates the risks of leaked secrets, the challenges of remediation, and the value of enabling [GitHub Secret Protection](https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security#github-secret-protection).
10+
11+
<hr>
12+
13+
**28 July 2025**
14+
15+
We have restructured the general "[Billing and payments](https://docs.github.com/en/billing)" articles to align with the Copilot and Actions docs. In addition, we've combined a few old "About" articles to directly answer common questions that new users have: [How GitHub billing works](https://docs.github.com/en/billing/get-started/how-billing-works) and [Introduction to billing and licensing](https://docs.github.com/en/billing/get-started/introduction-to-billing).
16+
17+
<hr>
18+
319
**16 July 2025**
420

521
We've added documentation describing how to use the GraphQL API to create a new issue and, in the same request, assign the issue to Copilot coding agent.
@@ -75,7 +91,7 @@ See [About Billing for GitHub Models](https://docs.github.com/billing/managing-b
7591

7692
**23 June 2025**
7793

78-
We’ve restructured our documentation around Copilot’s AI models to make it easier for users to understand, choose, and configure models across clients and plans. See [Supported AI models in Copilot](https://docs.github.com/copilot/using-github-copilot/ai-models/supported-ai-models-in-copilot) and [Choosing the right AI model for your task](https://docs.github.com/copilot/using-github-copilot/ai-models/choosing-the-right-ai-model-for-your-task).
94+
We’ve restructured our documentation around Copilot’s AI models to make it easier for users to understand, choose, and configure models across clients and plans. See [Supported AI models in Copilot](https://docs.github.com/copilot/using-github-copilot/ai-models/supported-ai-models-in-copilot) and [Choosing the right AI model for your task](https://docs.github.com/copilot/reference/ai-models/model-comparison).
7995

8096
<hr>
8197

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
# ---------------------------------------------------------------
99
# To update the sha:
1010
# https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble
11-
FROM ghcr.io/github/gh-base-image/gh-base-noble:20250715-152201-gef17a3886 AS base
11+
FROM ghcr.io/github/gh-base-image/gh-base-noble:20250805-204228-g50c20871f AS base
1212

1313
# Install curl for Node install and determining the early access branch
1414
# Install git for cloning docs-early-access & translations repos
22.3 KB
Loading
Binary file not shown.
-12 KB
Binary file not shown.
-101 KB
Binary file not shown.
-72.5 KB
Binary file not shown.
20.1 KB
Loading

0 commit comments

Comments
 (0)