documentation

This commit is contained in:
Earl Warren 2023-10-13 23:38:57 +02:00
parent 66eedaebbd
commit 7f524bea14
No known key found for this signature in database
GPG key ID: 0579CB2928A78A00
2 changed files with 109 additions and 1 deletions

View file

@ -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: