actions/cascading-pr
1
0
Fork 0
mirror of https://code.forgejo.org/actions/cascading-pr.git synced 2025-04-21 08:28:44 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

add destination-fork-repo to the README

Browse source
This commit is contained in:
Earl Warren 2023-11-01 17:47:42 +01:00
parent 5a2e9385b0
commit 9d138db73c
No known key found for this signature in database
GPG key ID: 0579CB2928A78A00
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -22,7 +22,7 @@ is ready to be reviewed.
The `update` script is expected to be found in the origin repository The `update` script is expected to be found in the origin repository
running the PR. It is given four arguments: running the PR. It is given four arguments:
* A directory in which the destination repository is checked-out * A directory in which the destination repository (or a fork) is checked-out
on the base branch on the base branch
* A file with the JSON describing the pull request in the * A file with the JSON describing the pull request in the
destination repository destination repository
@ -36,6 +36,9 @@ they will be pushed as a new commit in the PR.
When the PR is from a forked repository, the `update` script is checked out from When the PR is from a forked repository, the `update` script is checked out from
the default branch instead of the head branch of the fork. the default branch instead of the head branch of the fork.
If the fork of the destination repository is specified and it does
not exist, it is created.
<!-- action-docs-description --> <!-- action-docs-description -->
<!-- action-docs-inputs --> <!-- action-docs-inputs -->
## Inputs ## Inputs
@ -48,6 +51,7 @@ the default branch instead of the head branch of the fork.
| origin-pr | number of the PR in {orign-repo} | `true` | | | origin-pr | number of the PR in {orign-repo} | `true` | |
| destination-url | URL of the Forgejo instance where the cascading PR is created or updated (e.g. https://code.forgejo.org) | `true` | | | destination-url | URL of the Forgejo instance where the cascading PR is created or updated (e.g. https://code.forgejo.org) | `true` | |
| destination-repo | the repository in which the cascading PR is created or updated | `true` | | | destination-repo | the repository in which the cascading PR is created or updated | `true` | |
| destination-fork-repo | the fork of {desitnation-repo} in which the {destination-branch} will be created or updated | `false` | |
| destination-branch | the base branch of the destination repository for the cascading PR | `true` | | | destination-branch | the base branch of the destination repository for the cascading PR | `true` | |
| destination-token | a token with write permission on destination-repo | `true` | | | destination-token | a token with write permission on destination-repo | `true` | |
| update | path to the script to update the content of the cascading PR | `true` | | | update | path to the script to update the content of the cascading PR | `true` | |