FilesExpand file tree

main

/

ready-for-doc-review.yml

Copy path

View runs

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

54 lines (46 loc) · 2.32 KB

main

/

ready-for-doc-review.yml

Copy path

Top

File metadata and controls

• Code
• Blame

54 lines (46 loc) · 2.32 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

name: Ready for docs-content review

# **What it does**: Adds pull requests in the docs-internal repository to the docs-content review board when the "ready-for-doc-review" label is added or when a review by docs-content or docs-reviewers is requested. This workflow is also called as a reusable workflow from other repos including docs-content, docs-strategy, docs-early-access, and github.

# **Why we have it**: So that other GitHub teams can easily request reviews from the docs-content team, and so that writers can see when a PR is ready for review

# **Who does it impact**: Writers who need to review docs-related PRs

on:

pull_request:

types: [labeled, review_requested]

workflow_call:

permissions:

contents: read

jobs:

request_doc_review:

name: Request a review from the docs-content team

if: >-

github.repository_owner == 'github' && github.repository != 'github/docs' &&

(github.event.label.name == 'ready-for-doc-review' || github.event.requested_team.name == 'docs-content' || github.event.requested_team.name == 'docs-reviewers')

runs-on: ubuntu-latest

steps:

- name: Check out repo content

uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1

with:

repository: github/docs-internal

token: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}

- name: Setup Node.js

uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2

with:

node-version-file: 'package.json'

cache: npm

- name: Install dependencies

run: npm install @octokit/graphql

- name: Set AUTHOR_LOGIN

run: |

if [[ "${{ github.event.pull_request.assignee.login && github.event.pull_request.user.login == 'docs-bot' }}" ]]; then

echo "AUTHOR_LOGIN=${{ github.event.pull_request.assignee.login }}" >> $GITHUB_ENV

else

echo "AUTHOR_LOGIN=${{ github.event.pull_request.user.login }}" >> $GITHUB_ENV

fi

- name: Run script

run: |

node src/workflows/ready-for-docs-review.js

env:

TOKEN: ${{ secrets.DOCS_BOT_PAT_WRITEORG_PROJECT }}

PROJECT_NUMBER: 2936

ORGANIZATION: 'github'

ITEM_NODE_ID: ${{ github.event.pull_request.node_id }}

REPO: ${{ github.event.pull_request.base.repo.full_name }}