making abort_if_fail more verbose

Signed-off-by: vsoch <vsochat@stanford.edu>

README.md

@@ -46,14 +46,16 @@ Unlike standard actions, this action just uses variables from the environment.
 | PULL_REQUEST_REVIEWERS | A list (string with spaces) of users to assign review | false | unset |
 | PULL_REQUEST_TEAM_REVIEWERS | A list (string with spaces) of teams to assign review | false | unset |
 | PASS_ON_ERROR | Instead of failing on an error response, pass | unset |
+| PASS_IF_EXISTS | Instead of failing if the pull request already exists, pass | unset |
 
-For `PULL_REQUEST_DRAFT`, `PASS_ON_ERROR`, and `MAINTAINER_CANT_MODIFY`, these are
+For `PULL_REQUEST_DRAFT`, `PASS_ON_ERROR`, `PASS_IF_EXISTS`, and `MAINTAINER_CANT_MODIFY`, these are
 treated as environment booleans. If they are defined in the environment, they trigger the
 "true" condition. E.g.,:
 
  - Define `MAINTAINER_CANT_MODIFY` if you don't want the maintainer to be able to modify the pull request.
  - Define `PULL_REQUEST_DRAFT` if you want the PR to be a draft.
  - Define `PASS_ON_ERROR` if you want the PR to not exit given any non 200/201 response.
+ - Define `PASS_IF_EXISTS` if you want the PR to not exit given the pull request is already open.
 
 For `PULL_REQUEST_ASSIGNEES`, `PULL_REQUEST_REVIEWERS`, and `PULL_REQUEST_TEAM_REVIEWERS` 
 you can provide a string of one or more GitHub usernames (or team names) to
@@ -91,7 +93,7 @@ Example workflows are provided in [examples](examples), and please contribute an
 examples that you might have to help other users! We will walk through a basic
 example here for a niche case. Let's say that we are opening a pull request on the release event. This would mean
 that the payload's branch variable would be null. We would need to define `PULL_REQUEST_FROM`. How would
-we do that? We can [set environment variables](https://help.github.com/en/actions/reference/development-tools-for-github-actions#set-an-environment-variable-set-env) for next steps. Here is an example:
+we do that? We can [set environment variables](https://github.com/actions/toolkit/blob/main/docs/commands.md#environment-files) for next steps. Here is an example:
 
 ```yaml
 name: Pull Request on Branch Push
@@ -107,7 +109,7 @@ jobs:
         run: |
             # do custom parsing of your code / date to derive a branch from
             PR_BRANCH_FROM=release-v$(cat VERSION)
-            ::set-env name=PULL_REQUEST_FROM_BRANCH::${PR_BRANCH_FROM}
+            export "PULL_REQUEST_FROM_BRANCH=${PR_BRANCH_FROM}" >> $GITHUB_ENV
       - name: pull-request-action
         uses: vsoch/pull-request-action@1.0.6
         env:

examples/branch-from-environment.yml

@@ -40,7 +40,7 @@ jobs:
            git push origin "${BRANCH_FROM}"
         fi
         # Here is where we are setting the environment variable!
-        echo "::set-env name=PULL_REQUEST_FROM_BRANCH::${BRANCH_FROM}"
+        echo "PULL_REQUEST_FROM_BRANCH=${BRANCH_FROM}" >> $GITHUB_ENV
 
     - name: Open Pull Request
       uses: vsoch/pull-request-action@1.0.6

examples/custom-body-example.yml

@@ -0,0 +1,55 @@
+name: Hotfix Branch Pull Request
+on:
+  push:
+    branches-ignore:
+      - master
+      - production
+
+# See https://github.com/vsoch/pull-request-action/issues/47#issuecomment-707109132
+
+jobs:
+  auto-pull-request:
+    name: PullRequestAction
+    runs-on: ubuntu-latest
+    steps:
+      - name: Generate branch name
+        uses: actions/github-script@v3
+        id: set-branch-name
+        with:
+          script: |
+            const capitalize = (name) => name.charAt(0).toUpperCase() + name.slice(1);
+            const emoji = context.payload.ref.startsWith("refs/heads/feature")
+              ? "✨ "
+              : context.payload.ref.startsWith("refs/heads/hotfix")
+              ? "🚑 "
+              : "";
+            return `${emoji}${capitalize(
+              context.payload.ref
+                .replace("refs/heads/", "")
+                .replace(/-/g, " ")
+                .replace("feature ", "")
+                .replace("hotfix ", "")
+            )}`;
+          result-encoding: string
+      - name: Set branch name
+        run: echo "PULL_REQUEST_TITLE=${{steps.set-branch-name.outputs.result}}" >> $GITHUB_ENV
+      - name: Generate PR body
+        uses: actions/github-script@v3
+        id: set-pr-body
+        with:
+          script: |
+            return `I'm opening this pull request for this branch, pushed by @${
+              context.payload.head_commit.author.username
+            } with ${context.payload.commits.length} commit${
+              context.payload.commits.length === 1 ? "" : "s"
+            }.`;
+          result-encoding: string
+      - name: Set PR body
+        run: echo "PULL_REQUEST_BODY=${{steps.set-pr-body.outputs.result}}" >> $GITHUB_ENV
+      - name: pull-request-action
+        uses: vsoch/pull-request-action@1.0.10
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH_PREFIX: "hotfix-"
+          PULL_REQUEST_BRANCH: "production"
+          PULL_REQUEST_REVIEWERS: "AnandChowdhary"

pull-request.py

@@ -25,12 +25,19 @@ def check_events_json():
     return events
 
 
-def abort_if_fail(reason):
+def abort_if_fail(response, reason):
     """If PASS_ON_ERROR, don't exit. Otherwise exit with an error and print the reason"""
+    message = "%s: %s: %s\n %s" % (
+        reason,
+        response.status_code,
+        response.reason,
+        response.json(),
+    )
+
     if os.environ.get("PASS_ON_ERROR"):
-        print("Error, but PASS_ON_ERROR is set, continuing: %s" % reason)
+        print("Error, but PASS_ON_ERROR is set, continuing: %s" % message)
     else:
-        sys.exit(reason)
+        sys.exit(message)
 
 
 def parse_into_list(values):
@@ -41,6 +48,14 @@ def parse_into_list(values):
     return [x.strip() for x in values.split(" ")]
 
 
+def set_env(name, value):
+    """helper function to echo a key/value pair to the environement file"""
+    environment_file_path = os.environ.get("GITHUB_ENV")
+
+    with open(environment_file_path, "a") as environment_file:
+        environment_file.write("%s=%s" % (name, value))
+
+
 ################################################################################
 # Global Variables (we can't use GITHUB_ prefix)
 ################################################################################
@@ -73,18 +88,16 @@ def create_pull_request(
 ):
 
     # Check if the branch already has a pull request open
+    params = {"base": target, "head": source, "state": "open"}
     data = {"base": target, "head": source, "body": body}
-    print("Data for checking if pull request exists: %s" % data)
-    response = requests.get(PULLS_URL, json=data)
-    
+    print("Params for checking if pull request exists: %s" % params)
+    response = requests.get(PULLS_URL, params=params)
+
     # Case 1: 404 might warrant needing a token
     if response.status_code == 404:
-        response = requests.get(PULLS_URL, json=data, headers=HEADERS)
+        response = requests.get(PULLS_URL, params=params, headers=HEADERS)
     if response.status_code != 200:
-        abort_if_fail(
-            "Unable to retrieve information about pull requests: %s: %s"
-            % (response.status_code, response.reason)
-        )
+        abort_if_fail(response, "Unable to retrieve information about pull requests")
 
     response = response.json()
 
@@ -96,9 +109,15 @@ def create_pull_request(
                 print("Pull request from %s to %s is already open!" % (source, target))
                 is_open = True
 
+                # Does the user want to pass if the pull request exists?
+                if os.environ.get("PASS_IF_EXISTS"):
+                    print("PASS_IF_EXISTS is set, exiting with success status.")
+                    sys.exit(0)
+                break
+
     # Option 2: Open a new pull request
     if not is_open:
-        print("%s does not have a pull request open, continuing!" % source)
+        print("No pull request from %s to %s is open, continuing!" % (source, target))
 
         # Post the pull request
         data = {
@@ -112,14 +131,7 @@ def create_pull_request(
         print("Data for opening pull request: %s" % data)
         response = requests.post(PULLS_URL, json=data, headers=HEADERS)
         if response.status_code != 201:
-            abort_if_fail(
-                "Unable to create pull request: %s: %s, %s"
-                % (
-                    response.status_code,
-                    response.reason,
-                    response.json().get("message", ""),
-                )
-            )
+            abort_if_fail(response, "Unable to create pull request")
 
         # Expected return codes are 0 for success
         pull_request_return_code = (
@@ -132,13 +144,13 @@ def create_pull_request(
         number = response.get("number")
         html_url = response.get("html_url")
         print("Number opened for PR is %s" % number)
-        print("::set-env name=PULL_REQUEST_NUMBER::%s" % number)
+        set_env("PULL_REQUEST_NUMBER", number)
         print("::set-output name=pull_request_number::%s" % number)
-        print("::set-env name=PULL_REQUEST_RETURN_CODE::%s" % pull_request_return_code)
+        set_env("PULL_REQUEST_RETURN_CODE", pull_request_return_code)
         print(
             "::set-output name=pull_request_return_code::%s" % pull_request_return_code
         )
-        print("::set-env name=PULL_REQUEST_URL::%s" % html_url)
+        set_env("PULL_REQUEST_URL", html_url)
         print("::set-output name=pull_request_url::%s" % html_url)
 
         if assignees:
@@ -156,19 +168,12 @@ def create_pull_request(
             ASSIGNEES_URL = "%s/%s/assignees" % (ISSUE_URL, number)
             response = requests.post(ASSIGNEES_URL, json=data, headers=HEADERS)
             if response.status_code != 201:
-                abort_if_fail(
-                    "Unable to create assignees: %s: %s, %s"
-                    % (
-                        response.status_code,
-                        response.reason,
-                        response.json().get("message", ""),
-                    )
-                )
+                abort_if_fail(response, "Unable to create assignees")
 
             assignees_return_code = (
                 0 if response.status_code == 201 else response.status_code
             )
-            print("::set-env name=ASSIGNEES_RETURN_CODE::%s" % assignees_return_code)
+            set_env("ASSIGNEES_RETURN_CODE", assignees_return_code)
             print("::set-output name=assignees_return_code::%s" % assignees_return_code)
 
         if reviewers or team_reviewers:
@@ -190,14 +195,7 @@ def create_pull_request(
             data = {"reviewers": reviewers, "team_reviewers": team_reviewers}
             response = requests.post(REVIEWERS_URL, json=data, headers=HEADERS)
             if response.status_code != 201:
-                abort_if_fail(
-                    "Unable to assign reviewers: %s: %s, %s"
-                    % (
-                        response.status_code,
-                        response.reason,
-                        response.json().get("message", ""),
-                    )
-                )
+                abort_if_fail(response, "Unable to assign reviewers")
 
             reviewers_return_code = (
                 0 if response.status_code == 201 else response.status_code
@@ -206,7 +204,7 @@ def create_pull_request(
             print("::group::github reviewers response")
             print(response)
             print("::endgroup::github reviewers response")
-            print("::set-env name=REVIEWERS_RETURN_CODE::%s" % reviewers_return_code)
+            set_env("REVIEWERS_RETURN_CODE", reviewers_return_code)
             print("::set-output name=reviewers_return_code::%s" % reviewers_return_code)
             print("Add reviewers return code: %s" % reviewers_return_code)