From cacf8ffd44871a1df35a448d625cda98b2cd987b Mon Sep 17 00:00:00 2001 From: Timon Christiansen <32591853+8BitJonny@users.noreply.github.com> Date: Thu, 27 Oct 2022 07:02:39 -0400 Subject: [PATCH] (doc): add #165 limitation to readme --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index d382cd3..27565c2 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,8 @@ See [GitHub Documentation](https://docs.github.com/en/rest/commits/commits#list- echo "to ${{ fromJSON(steps.PR.outputs.pr).base.ref }}" ``` +## Limitations + ### Pull_request trigger If you use the `pull_request` event trigger, it won't find the associated PR for the first commit inside that same PR out of the box. @@ -107,6 +109,11 @@ To always find and pass the correct commit SHA to this action use this workflow ``` This will then work no matter the trigger event and no matter if it is the first PR commit or not. +### Can't find closed, unmerged PRs +Currently, if you try to find a PR that hasn't been merged yet AND which has been closed, then this app will completely fail in finding that PR. This workflow can only find open PRs, draft PRs and closed+merged PRs. + +See https://github.com/8BitJonny/gh-get-current-pr/issues/165 for the progress on this issue as this might come in a later version. + ## :computer: Contributing Contributions are always welcome!