8000 Repo sync by docs-bot · Pull Request #39061 · github/docs · GitHub
[go: up one dir, main page]

Skip to content

Repo sync #39061

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
144 changes: 144 additions & 0 deletions .github/workflows/create-changelog-pr.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
name: Create a PR to add an entry to the CHANGELOG.md file in this repo

# **What it does**: If a member of the github org posts a changelog comment, it creates a PR to update the CHANGELOG.md file.
# **Why we have it**: This surfaces docs changelog details publicly.
# **Who does it impact**: GitHub users and staff.

on:
issue_comment:
types: [created]
workflow_dispatch:

permissions:
contents: write
pull-requests: write

env:
CHANGELOG_FILE: CHANGELOG.md

jobs:
docs-changelog-pr:
if: ${{ github.repository == 'github/docs-internal' && github.event.issue.pull_request }}
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v4

- name: 'Ensure ${{ env.CHANGELOG_FILE }} exists'
run: |
if [ ! -f ${{ env.CHANGELOG_FILE }} ]; then
echo "${{ env.CHANGELOG_FILE }} is missing at the root of the repository."
exit 1
fi

- name: Check that the user belongs to the github org
id: hubber_check
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea
with:
github-token: ${{ secrets.DOCS_BOT_PAT_BASE }}
script: |
try {
await github.rest.teams.getMembershipForUserInOrg({
org: 'github',
team_slug: 'employees',
username: context.payload.sender.login,
});
core.exportVariable('CONTINUE_WORKFLOW', 'true');
} catch(err) {
core.info("Workflow triggered by a comment, but the commenter is not a Hubber. Exiting.");
core.exportVariable('CONTINUE_WORKFLOW', 'false');
}

- name: Check if comment starts with '## Changelog summary'
if: env.CONTINUE_WORKFLOW == 'true'
id: check_summary
env:
COMMENT_BODY: ${{ github.event.comment.body }}
run: |
# Get the first line of the comment and trim the leading/trailing whitespace:
FIRST_LINE=$(printf "%s\n" "$COMMENT_BODY" | head -n1 | sed 's/^[[:space:]]*//;s/[[:space:]]*$//')
if [[ "$FIRST_LINE" != '## Changelog summary' ]]; then
echo "FIRST_LINE=|$FIRST_LINE|"
echo "The pull request comment is not a changelog summary. Exiting."
echo "CONTINUE_WORKFLOW=false" >> $GITHUB_ENV
fi

- name: Create changelog text
if: env.CONTINUE_WORKFLOW == 'true'
id: create_text
env:
COMMENT_BODY: ${{ github.event.comment.body }}
run: |
set -euo pipefail
DATE=$(date +"**%-d %B %Y**")
BODY="$(printf "%s\n" "$COMMENT_BODY" | tail -n +2)"
CHANGELOG_TEXT="$(printf "%s\n" "$BODY" | awk '/^:writing_hand:/{exit} {print}')"
{
echo "$DATE"
echo -e "$CHANGELOG_TEXT\n<hr>"
} > changelog_entry.txt

- name: Set up git
if: env.CONTINUE_WORKFLOW == 'true'
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"

- name: Prepare branch
if: env.CONTINUE_WORKFLOW == 'true'
run: |
BRANCH="changelog-update-$(date +%s)"
echo "BRANCH=$BRANCH" >> $GITHUB_ENV
git checkout -b "$BRANCH"

# Insert new changelog entry after the first heading, as follows:
# Print the first line of the existing CHANGELOG.md file into a `tmp` file, followed by an empty line.
# Then, print the contents of `changelog_entry.txt` into the `tmp` file.
# Then, print the rest of the existing CHANGELOG.md file into the `tmp` file.
# Finally, replace the existing CHANGELOG.md file with the `tmp` file.
awk 'NR==1{print; print ""; while ((getline line < "changelog_entry.txt") > 0) print line; next}1' CHANGELOG.md > tmp && mv tmp CHANGELOG.md

git add CHANGELOG.md
git commit -m "Update changelog for $(head -n1 changelog_entry.txt)"
git push origin "$BRANCH"

- name: Create a pull request
if: env.CONTINUE_WORKFLOW == 'true'
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea
id: create_pull_request
with:
github-token: ${{ secrets.DOCS_BOT_PAT_BASE }}
script: |
const { data: pullRequest } = await github.rest.pulls.create({
owner: context.repo.owner,
repo: context.repo.repo,
title: `Update docs changelog (for PR #${context.payload.issue.number})`,
body: `### Automated docs changelog update\n\n**Purpose:** Update the <code>${{ env.CHANGELOG_FILE }}</code> file with details of a recent docs change.\n\nThis PR is an automated update, generated by the <code>create-changelog-pr.yml</code> Actions workflow as a result of a "Changelog summary" comment being added to [PR #${context.payload.issue.number}](${context.payload.issue.html_url}).\n\n**Note for reviewer**: This change to the <code>${{ env.CHANGELOG_FILE }}</code> file will be synced to the public docs site, so make sure that the content of the entry is appropriate for public consumption. If the content is wholly inappropriate for public consumption, then this PR can be closed.\n\n<details><summary>Original PR comment posted by @${context.payload.comment.user.login}, using the <code>/changelog</code> slash command:</summary>\n\n${context.payload.comment.body}</details>`,
head: process.env.BRANCH,
base: 'main'
});

core.setOutput('pull-request-number', pullRequest.number);
core.setOutput('pull-request-url', pullRequest.html_url);

- name: Add 'ready-for-doc-review' label to PR
if: env.CONTINUE_WORKFLOW == 'true'
uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea
env:
# Get the number of the PR that was just created:
PULL_REQUEST_NUMBER: ${{ steps.create_pull_request.outputs.pull-request-number }}
with:
github-token: ${{ secrets.DOCS_BOT_PAT_BASE }}
script: |
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: Number(process.env.PULL_REQUEST_NUMBER),
labels: ['ready-for-doc-review']
});

- uses: ./.github/actions/slack-alert
if: ${{ failure() && github.event_name != 'workflow_dispatch' }}
with:
slack_channel_id: ${{ secrets.DOCS_ALERTS_SLACK_CHANNEL_ID }}
slack_token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }}
31 changes: 31 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Docs changelog

**13 June 2025**

We've published a new article for people learning to code: "[Developing your project locally](https://docs.github.com/en/get-started/learning-to-code/developing-your-project-locally)."

This tutorial helps learners gain core skills needed to set up any project locally by working through an example client-side application using HTML, CSS, and JavaScript. The goal is to help new coders use GitHub tools to recognize patterns across different technologies and build confidence in their ability to set up any project locally.

<hr>

**13 June 2025**

To manage System for Cross-domain Identity Management (SCIM) integration with confidence, customers need to understand the different types of deprovisioning, the actions that trigger them, and their options for reinstating deprovisioned users.

We've published a new article to answer questions around suspending and reinstating Enterprise Managed Users, or users where SCIM is enabled on GitHub Enterprise Server: "[Deprovisioning and reinstating users with SCIM](https://docs.github.com/en/enterprise-cloud@latest/admin/managing-iam/provisioning-user-accounts-with-scim/deprovisioning-and-reinstating-users)".

<hr>

**11 June 2025**

We've added a new scenario-based guide for the Builder persona: "[Using Copilot to explore a codebase](https://docs.github.com/en/copilot/using-github-copilot/guides-on-using-github-copilot/using-copilot-to-explore-a-codebase)."

<hr>

**24 April 2025**

To help learners feel confident they are building real coding skills while using Copilot, we published [Setting up Copilot for learning to code](https://docs.github.com/en/get-started/learning-to-code/setting-up-copilot-for-learning-to-code).

This article helps learners take their first steps in coding with Copilot acting as a tutor, rather than a code completion tool. Configuring Copilot for learning emphasizes skill development and gives learners a way to use Copilot as a daily tool to foster learning and coding independence.

<hr>
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
# ---------------------------------------------------------------
# To update the sha:
# https://github.com/github/gh-base-image/pkgs/container/gh-base-image%2Fgh-base-noble
FROM ghcr.io/github/gh-base-image/gh-base-noble:20250619-223112-g14de19c1f AS base
FROM ghcr.io/github/gh-base-image/gh-base-noble:20250625-211326-g8ecab2454 AS base

# Install curl for Node install and determining the early access branch
# Install git for cloning docs-early-access & translations repos
Expand Down
12 changes: 0 additions & 12 deletions content/actions/about-github-actions/index.md

This file was deleted.

14 changes: 14 additions & 0 deletions content/actions/get-started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Get started with GitHub Actions
shortTitle: Get started
intro: "Learn the basics of GitHub Actions."
versions:
fpt: '*'
ghes: '*'
ghec: '*'
children:
- /quickstart
- /understanding-github-actions
redirect_from:
- /actions/about-github-actions
---
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
title: Quickstart for GitHub Actions
intro: 'Try out the features of {% data variables.product.prodname_actions %} in 5 minutes or less.'
intro: 'Try out the core features of {% data variables.product.prodname_actions %} in minutes.'
allowTitleToDifferFromFilename: true
redirect_from:
- /actions/getting-started-with-github-actions/starting-with-preconfigured-workflow-templates
- /actions/quickstart
- /actions/getting-started-with-github-actions
- /actions/writing-workflows/quickstart
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Understanding GitHub Actions
shortTitle: Understand GitHub Actions
intro: 'Learn the basics of {% data variables.product.prodname_actions %}, including core concepts and essential terminology.'
intro: 'Learn the basics of core concepts and essential terminology in {% data variables.product.prodname_actions %}.'
redirect_from:
- /github/automating-your-workflow-with-github-actions/core-concepts-for-github-actions
- /actions/automating-your-workflow-with-github-actions/core-concepts-for-github-actions
Expand All @@ -10,6 +10,7 @@ redirect_from:
- /actions/learn-github-actions/understanding-github-actions
- /actions/learn-github-actions/essential-features-of-github-actions
- /articles/getting-started-with-github-actions
- /actions/about-github-actions/understanding-github-actions
versions:
fpt: '*'
ghes: '*'
Expand Down
70 changes: 0 additions & 70 deletions content/actions/guides.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,7 @@ children:
- /viewing-github-actions-metrics
- /sharing-workflows-secrets-and-runners-with-your-organization
- /making-retired-namespaces-available-on-ghecom
redirect_from:
- /actions/administering-github-actions
---

Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ versions:
ghec: '*'
type: how_to
permissions: Enterprise owners
redirect_from:
- /actions/administering-github-actions/making-retired-namespaces-available-on-ghecom
---

## About retirement of namespaces
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ redirect_from:
- /actions/learn-github-actions/sharing-workflows-with-your-organization
- /actions/learn-github-actions/sharing-workflows-secrets-and-runners-with-your-organization
- /actions/using-workflows/sharing-workflows-secrets-and-runners-with-your-organization
- /actions/administering-github-actions/sharing-workflows-secrets-and-runners-with-your-organization
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ redirect_from:
- /actions/monitoring-and-troubleshooting-workflows/viewing-github-actions-usage-metrics-for-your-organization
- /actions/administering-github-actions/viewing-github-actions-usage-metrics-for-your-organization
- /actions/administering-github-actions/viewing-github-actions-metrics-for-your-organization
- /actions/administering-github-actions/viewing-github-actions-metrics
---

{% data reusables.actions.about-actions-metrics %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ redirect_from:
- /actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners
- /actions/using-github-hosted-runners/using-groups-to-manage-access-to-ae-hosted-runners
- /actions/using-github-hosted-runners/creating-custom-images
- /actions/hosting-your-own-runners
versions:
fpt: '*'
ghes: '*'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ type: overview
topics:
- Actions Runner Controller
defaultPlatform: linux
redirect_from:
- /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/authenticating-to-the-github-api
---

[Legal notice](#legal-notice)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ type: overview
topics:
- Actions Runner Controller
defaultPlatform: linux
redirect_from:
- /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/deploying-runner-scale-sets-with-actions-runner-controller
---

[Legal notice](#legal-notice)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ children:
- /deploying-runner-scale-sets-with-actions-runner-controller
- /using-actions-runner-controller-runners-in-a-workflow
- /troubleshooting-actions-runner-controller-errors
redirect_from:
- /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller
---

{% data reusables.actions.enterprise-github-hosted-runners %}
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ versions:
type: how_to
topics:
- Actions Runner Controller
redirect_from:
- /actions/hosting-your-own-runners/managing-self-hosted-runners-with-actions-runner-controller/troubleshooting-actions-runner-controller-errors
---

[Legal notice](#legal-notice)
Expand Down
Loading
Loading
0