Skip to content

Commit 4f1c34f

Browse files
committed
Update README: explain the limitation
1 parent f271b2a commit 4f1c34f

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22

33
Example of [codemaker-pull-request-action](https://github.com/codemakerai/codemaker-pull-request-action)
44

5-
Requirements: give workflow write access to your repo.
5+
### Requirements
66

7-
Under repo Settings -> Actions -> General -> Workflow permissions, make sure "Read and write permissions" is selected.
7+
Requirements: give workflow write access to your repo: Under repo Settings -> Actions -> General -> Workflow permissions, make sure "Read and write permissions" is selected.
8+
9+
### Caveat
10+
11+
Due to the limitation of Github workflow, there is no good way to handle concurrent run. This is especially because that the comment line number is an import parameter for CodeMaker processor to perform generation. Since the line number is determined when ```pull_request_review_comment``` web hook event is triggerred, multiple concurrent workflow trigger will cause the line number to be outdated because some other runs may have already updated the file content.
12+
13+
Because of this limitation, it is important to post PR comment one by one, and do not post a new one until the workflow run triggerred by the previous one has completed.

0 commit comments

Comments
 (0)