Skip to content

Commit 2425cea

Browse files
update readme
1 parent 24240fb commit 2425cea

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

track-review-project/README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ requested and performed. If a CR hasn't been requested, it will do so when
77
moving to the CR state. It will also add the PR author as an assignee if none
88
exist.
99

10+
In order for this to work with forks when reviews are completed, a triggering
11+
workflow is also required. This can be shown by the "Trigger Project Workflow"
12+
yaml file below. The "Track Action Project" workflow is triggered by this
13+
workflow via github "workflow_run" syntax.
14+
1015
It requires a PAT with permissions to write to projects to be added as a secret
1116
to the repository with the name `PROJECT_ACTION_PAT`. Project edits made using
1217
this token will be shown as performed by the owner of the token.
@@ -17,10 +22,10 @@ this token will be shown as performed by the owner of the token.
1722
name: Track Review Project
1823

1924
on:
20-
pull_request_target:
21-
types: ["opened", "synchronize", "reopened", "edited", "review_requested", "review_request_removed"]
22-
pull_request_review:
23-
pull_request_review_comment:
25+
workflow_run:
26+
workflows: [Trigger Review Project]
27+
types:
28+
- completed
2429
workflow_dispatch:
2530

2631
jobs:
@@ -34,3 +39,18 @@ jobs:
3439
project_number: 376
3540

3641
```
42+
43+
```yaml
44+
name: Trigger Review Project
45+
46+
on:
47+
pull_request_target:
48+
types: ["opened", "synchronize", "reopened", "edited", "review_requested", "review_request_removed"]
49+
pull_request_review:
50+
pull_request_review_comment:
51+
52+
jobs:
53+
trigger_project_workflow:
54+
uses: MetOffice/growss/.github/workflows/trigger-project-workflow.yaml@develop
55+
secrets: inherit
56+
```

0 commit comments

Comments
 (0)