Skip to content

Commit

Permalink
Merge pull request #36018 from github/repo-sync
Browse files Browse the repository at this point in the history
Repo sync
  • Loading branch information
docs-bot authored Jan 21, 2025
2 parents e81bb75 + 62fbf68 commit 2f047b2
Show file tree
Hide file tree
Showing 52 changed files with 151 additions and 959 deletions.
34 changes: 0 additions & 34 deletions .github/workflows/codeowners-content-systems.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .github/workflows/no-response.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ jobs:
This PR has been automatically closed because there has been no response to
to our request for more information from the original author. Please reach out
if you have the information we requested, or open a [new issue](https://github.com/github/docs/issues/new/choose)
to describing your changes. Then we can begin the review process.
to describe your changes. Then we can begin the review process.
- name: Check out repo
if: ${{ failure() }}
Expand Down
41 changes: 41 additions & 0 deletions .github/workflows/reviewers-content-systems.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Reviewers - Content Systems

# **What it does**: Automatically add reviewers based on paths, but only for the docs-internal repo.
# **Why we have it**: So we can have reviewers automatically without getting open source notifications.
# **Who does it impact**: Docs team.

on:
pull_request:
paths:
- 'contributing/content-*.md'
- 'content/contributing/**.md'
- .github/workflows/reviewers-content-systems.yml

permissions:
contents: read
pull-requests: write
repository-projects: read

jobs:
reviewers-content-systems:
if: >-
${{ github.repository == 'github/docs-internal' &&
!github.event.pull_request.draft &&
!contains(github.event.pull_request.labels.*.name, 'reviewers-content-systems') &&
github.event.pull_request.head.ref != 'repo-sync' }}
runs-on: ubuntu-latest
env:
PR: ${{ github.event.pull_request.html_url }}
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}

steps:
- name: Check out repo
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

- name: Add content systems as a reviewer
run: |
labels=$(gh pr view ${{ github.event.pull_request.number }} --json labels --jq '.labels[].name')
if ! echo "$labels" | grep -q 'reviewers-content-systems'; then
gh pr edit $PR --add-reviewer github/docs-content-systems
gh pr edit $PR --add-label reviewers-content-systems
fi
30 changes: 19 additions & 11 deletions .github/workflows/reviewers-dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Add Dependabot Core Maintainers as Reviewers
name: Reviewers - Dependabot

# **What it does**: Automatically add reviewers based on paths, for docs-internal and docs repos.
# **Why we have it**: So dependabot maintainers can be notified about relevant pull requests.
Expand All @@ -10,25 +10,33 @@ on:
- 'data/reusable/dependabot/**'
- 'content/code-security/dependabot/**'
- 'content/rest/dependabot/**'
- '.github/workflows/reviewers-dependabot.yml'

permissions:
contents: read
pull-requests: write
repository-projects: read

jobs:
add-reviewer:
if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
if: >-
${{ github.repository == 'github/docs-internal' &&
!github.event.pull_request.draft &&
!contains(github.event.pull_request.labels.*.name, 'reviewers-dependabot') &&
github.event.pull_request.head.ref != 'repo-sync' }}
runs-on: ubuntu-latest
env:
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}
PR: ${{ github.event.pull_request.html_url }}

steps:
- name: Check out repo
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

- name: Add Dependabot Core Maintainers as reviewers
env:
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}
PR: ${{ github.event.pull_request.html_url }}
run: |
has_reviewer=$(
gh pr view $PR --json reviews |
jq 'any(.reviews[]; select(length > 0))'
)
if ! $has_reviewer
then
labels=$(gh pr view ${{ github.event.pull_request.number }} --json labels --jq '.labels[].name')
if ! echo "$labels" | grep -q 'reviewers-dependabot'; then
gh pr edit $PR --add-reviewer github/dependabot-updates-reviewers
gh pr edit $PR --add-label reviewers-dependabot
fi
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Codeowners - Docs Engineering
name: Reviewers - Docs Engineering

# **What it does**: Automatically add reviewers based on paths, but only for the docs-internal repo.
# And sets the 'engineering' label on the PR. It also edits the PR body to add a template
Expand All @@ -25,35 +25,33 @@ on:
- '.github/**'
- '**Dockerfile'
- 'package*.json'
- .github/workflows/codeowners-docs-engineering.yml
- .github/workflows/reviewers-docs-engineering.yml

permissions:
contents: read
pull-requests: write
repository-projects: read

jobs:
codeowners-docs-engineering:
if: >-
${{ github.repository == 'github/docs-internal' &&
!github.event.pull_request.draft &&
!contains(github.event.pull_request.labels.*.name, 'engineering') &&
!contains(github.event.pull_request.labels.*.name, 'reviewers-docs-engineering') &&
github.event.pull_request.head.ref != 'repo-sync' }}
runs-on: ubuntu-latest
env:
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}
PR: ${{ github.event.pull_request.html_url }}
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}

steps:
- name: Check out repo
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

- name: Label as engineering
run: gh pr edit $PR --add-label engineering

- name: Add Docs Engineering as a reviewer
- name: Add docs engineering as a reviewer
run: |
needs_review=$(
gh pr view $PR --json reviews |
jq '.reviews |
length == 0 or all(.author.login == "${{github.event.pull_request.user.login}}")'
)
if $needs_review
then
labels=$(gh pr view ${{ github.event.pull_request.number }} --json labels --jq '.labels[].name')
if ! echo "$labels" | grep -q 'reviewers-docs-engineering'; then
gh pr edit $PR --add-reviewer github/docs-engineering
gh pr edit $PR --add-label reviewers-docs-engineering
fi
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Codeowners - Legal
name: Reviewers - Legal

# **What it does**: Enforces reviews of Responsible AI (RAI) content by the GitHub legal team. Because RAI content can live anywhere in the content directory, it becomes a maintenance problem to use CODEOWNERS to enforce review on each article.
# **Why we have it**: RAI content must be reviewed by the GitHub legal team.
Expand All @@ -15,7 +15,7 @@ on:
- synchronize
paths:
- 'content/**'
- .github/workflows/codeowners-legal.yml
- .github/workflows/reviewers-legal.yml

permissions:
contents: read
Expand All @@ -27,6 +27,7 @@ jobs:
if: >-
${{ github.repository == 'github/docs-internal' &&
!github.event.pull_request.draft &&
!contains(github.event.pull_request.labels.*.name, 'reviewers-legal') &&
github.event.pull_request.head.ref != 'repo-sync' }}
runs-on: ubuntu-latest
steps:
Expand Down Expand Up @@ -62,7 +63,7 @@ jobs:
- name: Check for reviewers-legal label, add if missing and request review
if: steps.checkContentType.outputs.containsContentType == 'true'
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GH_TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}
PR: ${{ github.event.pull_request.html_url }}
run: |
labels=$(gh pr view ${{ github.event.pull_request.number }} --json labels --jq '.labels[].name')
Expand Down
2 changes: 1 addition & 1 deletion content/issues/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ children:
- /organizing-your-work-with-project-boards
- /using-labels-and-milestones-to-track-work
- /guides
product_video: '{% ifversion projects-v2 %}https://www.youtube-nocookie.com/embed/yFQ-p6wMS_Y{% endif %}'
product_video: 'https://www.youtube-nocookie.com/embed/yFQ-p6wMS_Y'
product_video_transcript: /video-transcripts/transcript-using-projects-for-feature-planning
redirect_from:
- /github/managing-your-work-on-github/managing-your-work-with-issues-and-pull-requests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ You can also configure workflow automations to keep your {% data variables.proje
{% data reusables.profile.access_profile %}
1. On the top of your profile page, in the main navigation, click **{% octicon "project" aria-hidden="true" %} Projects**.

![Screenshot showing profile tabs. The 'Projects' tab is highlighted with an orange outline.](/assets/images/help/projects-v2/tab-projects.png){% ifversion projects-v2 %}
![Screenshot showing profile tabs. The 'Projects' tab is highlighted with an orange outline.](/assets/images/help/projects-v2/tab-projects.png)

1. Click **Projects (classic)**{% endif %}
1. Click **Projects (classic)**.
{% data reusables.project-management.click-new-project %}
{% data reusables.project-management.create-project-name-description %}
{% data reusables.project-management.choose-template %}
Expand All @@ -64,8 +64,8 @@ You can also configure workflow automations to keep your {% data variables.proje
{% data reusables.profile.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.organization-wide-project %}{% ifversion projects-v2 %}
1. Click **Projects (classic)**{% endif %}
{% data reusables.organizations.organization-wide-project %}
1. Click **Projects (classic)**.
{% data reusables.project-management.click-new-project %}
{% data reusables.project-management.create-project-name-description %}
{% data reusables.project-management.choose-template %}
Expand All @@ -88,8 +88,8 @@ You can also configure workflow automations to keep your {% data variables.proje
{% data reusables.projects.classic-project-creation %}

{% data reusables.repositories.navigate-to-repo %}
1. Under your repository name, click **{% octicon "project" aria-hidden="true" %} Projects**.{% ifversion projects-v2 %}
1. Click **Projects (classic)**{% endif %}
1. Under your repository name, click **{% octicon "project" aria-hidden="true" %} Projects**.
1. Click **Projects (classic)**.
{% data reusables.project-management.click-new-project %}
{% data reusables.project-management.create-project-name-description %}
{% data reusables.project-management.choose-template %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,8 @@ You can also configure the default base permission at the organization-level for

You can also add teams, external collaborators, and individual organization members as collaborators for an organization-level project. For more information, see [AUTOTITLE](/organizations/organizing-members-into-teams/about-teams).

{% ifversion projects-v2-add-to-team %}

If you grant a team read permissions or greater for a project, the project is also displayed on the team's projects page. You can also add projects to a team on the team's projects page. For more information, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/managing-your-project/adding-your-project-to-a-team).

{% endif %}

You can only invite an individual user to collaborate on your organization-level project if they are already a member of the organization or an outside collaborator on at least one repository in the organization.

{% data reusables.projects.project-settings %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,7 @@ Below is an example of a `front-end` label that we created and added to the issu

![Screenshot of an issue called "Front-end work for Project Octocat." In the right sidebar, in the "Labels" section, the "front-end" label is applied.](/assets/images/help/issues/quickstart-add-label-to-issue.png)

## Adding issues to a {% data variables.projects.projects_v1_board %}

{% ifversion projects-v2 %}
## Adding issues to a {% data variables.projects.projects_v2 %}

You can use {% data variables.projects.projects_v2 %} on {% data variables.product.prodname_dotcom %} to plan and track the work for your team. A project is a customizable spreadsheet that integrates with your issues and pull requests on {% data variables.product.prodname_dotcom %}, automatically staying up-to-date with the information on {% data variables.product.prodname_dotcom %}. You can customize the layout by filtering, sorting, and grouping your issues and PRs. To get started with projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/quickstart-for-projects).

Expand All @@ -171,10 +169,9 @@ We can also view the same project as a board.

![Screenshot of the board view of a project, with issues organized into columns for "No Status," "Todo," "In Progress," and "Done."](/assets/images/help/issues/quickstart-projects-board-view.png)

{% endif %}
{% ifversion projects-v1 %}

You can {% ifversion projects-v2 %} also use the existing{% else %} use{% endif %} {% data variables.product.prodname_projects_v1 %} on {% data variables.product.prodname_dotcom %} to plan and track your or your team's work. {% data variables.projects.projects_v1_boards_caps %} are made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. You can create {% data variables.projects.projects_v1_boards %} for feature work, high-level roadmaps, or even release checklists. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).
You can also use the existing {% data variables.product.prodname_projects_v1 %} on {% data variables.product.prodname_dotcom %} to plan and track your or your team's work. {% data variables.projects.projects_v1_boards_caps %} are made up of issues, pull requests, and notes that are categorized as cards in columns of your choosing. You can create {% data variables.projects.projects_v1_boards %} for feature work, high-level roadmaps, or even release checklists. For more information, see [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards).

### {% data variables.projects.projects_v1_board_caps %} example

Expand All @@ -193,6 +190,6 @@ You have now learned about the tools {% data variables.product.prodname_dotcom %
* [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates) for learning more about issue templates
* [AUTOTITLE](/issues/using-labels-and-milestones-to-track-work/managing-labels) for learning how to create, edit and delete labels
* [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) for learning more about task lists
{% ifversion projects-v2 %} - [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects) for learning more about projects
* [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view) for learning how to customize views for projects{% endif %}
* [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects) for learning more about projects
* [AUTOTITLE](/issues/planning-and-tracking-with-projects/customizing-views-in-your-project/changing-the-layout-of-a-view) for learning how to customize views for projects
{% ifversion projects-v1 %}- [AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards) for learning how to manage {% data variables.projects.projects_v1_boards %}{% endif %}
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ To communicate responsibility, you can assign the issue to a member of your orga

## Adding the issue to a project

You can add the issue to an existing project{% ifversion projects-v2 %} and populate metadata for the project. {% endif %} For more information about projects, see {% ifversion projects-v2 %}[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).{% else %}[AUTOTITLE](/issues/organizing-your-work-with-project-boards).{% endif %}
You can add the issue to an existing project and populate metadata for the project. For more information about projects, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).

![Screenshot of the new issue form. In the right sidebar, the "Projects" section is outlined in dark orange.](/assets/images/help/issues/issue-project.png)

Expand Down Expand Up @@ -101,5 +101,5 @@ To break your issue down into more manageable tasks, you can add multiple levels
Here are some helpful resources for taking your next steps with {% data variables.product.prodname_github_issues %}:

* To learn more about issues, see [AUTOTITLE](/issues/tracking-your-work-with-issues/about-issues).
* To learn more about how projects can help you with planning and tracking, see {% ifversion projects-v2 %}[AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).{% else %}[AUTOTITLE](/issues/organizing-your-work-with-project-boards).{% endif %}
* To learn more about how projects can help you with planning and tracking, see [AUTOTITLE](/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).
* To learn more about using issue templates{% ifversion fpt or ghec %} and issue forms{% endif %} to encourage contributors to provide specific information, see [AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests).
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ An outside collaborator is a person who isn't explicitly a member of your organi

{% data reusables.profile.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.organization-wide-project %}{% ifversion projects-v2 %}
1. Click **Projects (classic)**{% endif %}
{% data reusables.organizations.organization-wide-project %}
1. Click **Projects (classic)**.
{% data reusables.project-management.select-project %}
{% data reusables.project-management.click-menu %}
{% data reusables.project-management.access-collaboration-settings %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ By default, organization members have write access to their organization's {% da
{% data reusables.profile.access_org %}
{% data reusables.user-settings.access_org %}
{% data reusables.organizations.organization-wide-project %}{% ifversion projects-v2 %}
1. Click **Projects (classic)**{% endif %}
{% data reusables.organizations.organization-wide-project %}
1. Click **Projects (classic)**.
{% data reusables.project-management.select-project %}
{% data reusables.project-management.click-menu %}
{% data reusables.project-management.access-collaboration-settings %}
Expand Down
Loading

0 comments on commit 2f047b2

Please sign in to comment.