mirror of
https://code.forgejo.org/actions/cascading-pr.git
synced 2025-07-02 23:03:44 +00:00
documentation
This commit is contained in:
parent
66eedaebbd
commit
7f524bea14
2 changed files with 109 additions and 1 deletions
28
action.yml
28
action.yml
|
@ -2,7 +2,33 @@
|
|||
name: 'Cascading PR'
|
||||
author: 'Forgejo authors'
|
||||
description: |
|
||||
Create and update a PR in another repository
|
||||
|
||||
When used in a workflow triggered by a PR event, it will create,
|
||||
update and close a matching PR in another repository. Whenever the
|
||||
matching PR is modified by `cascading-pr`, it waits for the CI to
|
||||
pass otherwise it fails.
|
||||
|
||||
As an example, when a PR is created in
|
||||
[`forgejo/runner`](https://code.forgejo.org/forgejo/runner/), a
|
||||
matching PR is created in
|
||||
[`actions/setup-forgejo`](https://code.forgejo.org/actions/setup-forgejo/)
|
||||
with the proposed change. `cascading-pr` will wait until the CI in
|
||||
`actions/setup-forgejo` is successful. When the PR in
|
||||
`forgejo/runner` is merged, the matching PR in
|
||||
`actions/setup-forgejo` is updated to use what was just merged and
|
||||
is ready to be reviewed.
|
||||
|
||||
The `update` script is expected to be found in the checked out repository
|
||||
running the PR. It is given three arguments:
|
||||
|
||||
* A directory in which the destination repository is checked-out
|
||||
* A file with the JSON describing the pull request in the
|
||||
destination repository
|
||||
* A file with the JSON describing the pull request in the
|
||||
origin repository
|
||||
|
||||
If changes are found in the destination repository directory, they will be
|
||||
pushed as a new commit in the PR.
|
||||
|
||||
inputs:
|
||||
origin-url:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue