fixing up GitHub action to work with yaml syntax

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

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine
+FROM debian:jessie-slim
 
 # docker build -t vanessa/pull-request-action .
 
@@ -7,7 +7,7 @@ LABEL "com.github.actions.description"="Create a pull request when a branch is c
 LABEL "com.github.actions.icon"="activity"
 LABEL "com.github.actions.color"="yellow"
 
-RUN apk --no-cache add curl wget git bash jq
+RUN apt-get update && apt-get install -y jq curl wget git
 COPY pull-request.sh /pull-request.sh
 
 RUN chmod u+x /pull-request.sh

README.md

@@ -22,70 +22,23 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: pull-request-action
-        uses: vsoch/pull-request-action@1.0.2
+        uses: vsoch/pull-request-action@master
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           BRANCH_PREFIX: "update/"
           PULL_REQUEST_BRANCH: "master"
 ```
 
-## Environment Variables
+Environment variables include:
 
-Unlike standard actions, this action just uses variables from the environment.
+  - **BRANCH_PREFIX**: the prefix to filter to. If the branch doesn't start with the prefix, it will be ignored
-
+  - **PULL_REQUEST_BRANCH**: the branch to issue the pull request to. Defaults to master.
-| Name | Description | Required | Default |
+  - **PULL_REQUEST_BODY**: the body for the pull request (optional)
-|------|-------------|----------|---------|
+  - **PULL_REQUEST_TITLE**: the title for the pull request  (optional)
-| BRANCH_PREFIX | the prefix to filter to. If the branch doesn't start with the prefix, it will be ignored | false | "" |
+  - **PULL_REQUEST_DRAFT**: should the pull request be a draft PR? (optional; unset defaults to `false`)
-| PULL_REQUEST_BRANCH | open pull request against this branch | false | master |
-| PULL_REQUEST_FROM_BRANCH | if a branch isn't found in your GitHub payload, use this branch | false | |
-| PULL_REQUEST_BODY | the body for the pull request | false | |
-| PULL REQUEST_TITLE | the title for the pull request | false | |
-| PULL REQUEST_DRAFT | should this be a draft PR? | false | false |
-
-All booleans should be lowercase.
 
 The `GITHUB_TOKEN` secret is required to interact and authenticate with the GitHub API to open
-the pull request. The example is [deployed here](https://github.com/vsoch/pull-request-action-example) with an example opened (and merged) [pull request here](https://github.com/vsoch/pull-request-action-example/pull/1) if needed.
+the pull request.
-
-
-## Examples
-
-Example workflows are provided in [examples](examples), and please contribute any
-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:
-
-```yaml
-name: Pull Request on Branch Push
-on: [release]
-jobs:
-  pull-request-on-release:
-    name: PullRequestAction
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v2
-      - name: Derive from branch name
-        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}
-      - name: pull-request-action
-        uses: vsoch/pull-request-action@1.0.2
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          PULL_REQUEST_BRANCH: "master"
-```
-
-The above workflow is triggered on a release, so the branch will be null in the GItHub
-payload. Since we want the release PR to come from a special branch, we derive it
-in the second step, and then set the `PULL_REQUEST_FROM_BRANCH` variable in the environment
-for the next step. In the Pull Request Action step, the pull request
-will be opened from `PULL_REQUEST_FROM_BRANCH` against `PULL_REQUEST_BRANCH`, which is
-master. If we do not set this variable, the job will exit in an error,
-as it is not clear what action to take.
-
 
 ## Example use Case: Update Registry
 

action.yml

@@ -1,9 +0,0 @@
-name: 'Pull Request Action'
-description: 'A GitHub action to open a pull request'
-author: 'vsoch'
-runs:
-  using: 'docker'
-  image: 'Dockerfile'
-branding:
-  icon: 'activity'  
-  color: 'yellow'

examples/push-example.yml

@@ -1,18 +0,0 @@
-name: Pull Request on Branch Push
-on:
-  push:
-    branches-ignore:
-      - staging
-      - launchpad
-      - production
-jobs:
-  auto-pull-request:
-    name: PullRequestAction
-    runs-on: ubuntu-latest
-    steps:
-      - name: pull-request-action
-        uses: vsoch/pull-request-action@add/support-null-branch
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH_PREFIX: "update/"
-          PULL_REQUEST_BRANCH: "master"

examples/release-example.yml

@@ -1,48 +0,0 @@
-on:
-  release:
-    types:
-      - published
-
-jobs:
-  persist-new-suite-yml:
-    name: Commit Suite Release YML
-    runs-on: ubuntu-latest
-
-    steps:
-      # Likely other steps go here
-    - name: Set BRANCH_NAME
-      run: |
-        tag_name=${{github.event.release.tag_name}}
-        echo "Tag: $tag_name"
-
-        version=$(echo "$tag_name" | sed 's/^v//')
-        echo "Version: $version"
-
-        echo "::set-output name=suite_version::${version}"
-        echo "::set-output name=suite_update_branch::suite_${version}"
-      id: data
-
-    - name: Permanently save the new suite release
-      run: |
-        mkdir -p releases
-
-        new_suite_version_yml="releases/suite_${{ steps.data.outputs.suite_version }}.yml"
-        echo "Suite target file: $new_suite_version_yml"
-
-        cp suite.yml "${new_suite_version_yml}"
-
-        git add "${new_suite_version_yml}"
-        git commit -m "Suite v${{ steps.data.outputs.suite_version }} auto-commit of new release files"
-
-    - name: Push files
-      run: |
-        git push --force "https://${{ github.actor }}:${{secrets.GITHUB_TOKEN}}@github.com/${{ github.repository }}.git" "HEAD:${{ steps.data.outputs.suite_update_branch }}"
-
-    - name: Open a PR to the default branch
-      uses: vsoch/pull-request-action@1.0.2
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        PULL_REQUEST_FROM_BRANCH: "${{ steps.data.outputs.suite_update_branch }}"
-        PULL_REQUEST_BRANCH: master
-        PULL_REQUEST_TITLE: "Action: Update suite release file for v${{ steps.data.outputs.suite_version }}"
-        PULL_REQUEST_BODY: "Auto-generated PR!"

pull-request.sh

@@ -26,7 +26,7 @@ PULLS_URL=$REPO_URL/pulls
 check_credentials() {
 
     if [[ -z "${GITHUB_TOKEN}" ]]; then
-        printf "You must include the GITHUB_TOKEN as an environment variable.\n"
+        echo "You must include the GITHUB_TOKEN as an environment variable."
         exit 1
     fi
 
@@ -35,44 +35,37 @@ check_credentials() {
 check_events_json() {
 
     if [[ ! -f "${GITHUB_EVENT_PATH}" ]]; then
-        printf "Cannot find Github events file at ${GITHUB_EVENT_PATH}\n";
+        echo "Cannot find Github events file at ${GITHUB_EVENT_PATH}";
         exit 1;
     fi
-    printf "Found ${GITHUB_EVENT_PATH}\n";
+    echo "Found ${GITHUB_EVENT_PATH}";
     
 }
 
 create_pull_request() {
 
-    # JSON strings
+    SOURCE="${1}"  # from this branch
-    SOURCE="$(echo -n "${1}" | jq --raw-input --slurp ".")"  # from this branch
+    TARGET="${2}"  # pull request TO this target
-    TARGET="$(echo -n "${2}" | jq --raw-input --slurp ".")"  # pull request TO this target
+    BODY="${3}"    # this is the content of the message
-    BODY="$(echo -n "${3}" | jq --raw-input --slurp ".")"    # this is the content of the message
+    TITLE="${4}"   # pull request title
-    TITLE="$(echo -n "${4}" | jq --raw-input --slurp ".")"   # pull request title
+    DRAFT="${5}"   # if PRs are draft
-
-    # JSON boolean
-    if [[ "${5}" ==  "true" ]]; then                         # if PRs are draft
-        DRAFT="true";
-    else
-        DRAFT="false";
-    fi
 
     # Check if the branch already has a pull request open 
 
-    DATA="{\"base\":${TARGET}, \"head\":${SOURCE}, \"body\":${BODY}}"
+    DATA="{\"base\":\"${TARGET}\", \"head\":\"${SOURCE}\", \"body\":\"${BODY}\"}"
     RESPONSE=$(curl -sSL -H "${AUTH_HEADER}" -H "${HEADER}" --user "${GITHUB_ACTOR}" -X GET --data "${DATA}" ${PULLS_URL})
     PR=$(echo "${RESPONSE}" | jq --raw-output '.[] | .head.ref')
-    printf "Response ref: ${PR}\n"
+    echo "Response ref: ${PR}"
 
     # Option 1: The pull request is already open
     if [[ "${PR}" == "${SOURCE}" ]]; then
-        printf "Pull request from ${SOURCE} to ${TARGET} is already open!\n"
+        echo "Pull request from ${SOURCE} to ${TARGET} is already open!"
 
     # Option 2: Open a new pull request
     else
         # Post the pull request
-        DATA="{\"title\":${TITLE}, \"body\":${BODY}, \"base\":${TARGET}, \"head\":${SOURCE}, \"draft\":${DRAFT}}"
+        DATA="{\"title\":\"${TITLE}\", \"base\":\"${TARGET}\", \"head\":\"${SOURCE}\", \"draft\":\"${DRAFT}\"}"
-        printf "curl --user ${GITHUB_ACTOR} -X POST --data ${DATA} ${PULLS_URL}\n"
+        echo "curl --user ${GITHUB_ACTOR} -X POST --data ${DATA} ${PULLS_URL}"
         curl -sSL -H "${AUTH_HEADER}" -H "${HEADER}" --user "${GITHUB_ACTOR}" -X POST --data "${DATA}" ${PULLS_URL}
         echo $?
     fi
@@ -88,45 +81,32 @@ main () {
 
     # User specified branch to PR to, and check
     if [ -z "${BRANCH_PREFIX}" ]; then
-        printf "No branch prefix is set, all branches will be used.\n"
+        echo "No branch prefix is set, all branches will be used."
         BRANCH_PREFIX=""
-        printf "Branch prefix is $BRANCH_PREFIX\n"
+        echo "Branch prefix is $BRANCH_PREFIX"
     fi
 
     if [ -z "${PULL_REQUEST_BRANCH}" ]; then
         PULL_REQUEST_BRANCH=master
     fi
-    printf "Pull requests will go to ${PULL_REQUEST_BRANCH}\n"
+    echo "Pull requests will go to ${PULL_REQUEST_BRANCH}"
 
     if [ -z "${PULL_REQUEST_DRAFT}" ]; then
-        printf "No explicit preference for draft PR: created PRs will be normal PRs.\n"
+        echo "No explicit preference for draft PR: created PRs will be normal PRs."
         PULL_REQUEST_DRAFT="false"
     else
-        printf "Environment variable PULL_REQUEST_DRAFT set to a value: created PRs will be draft PRs.\n"
+        echo "Environment variable PULL_REQUEST_DRAFT set to a value: created PRs will be draft PRs."
         PULL_REQUEST_DRAFT="true"
     fi
 
-    # The user is allowed to explicitly set the name of the branch
+    # Get the name of the action that was triggered
-    if [ -z "${PULL_REQUEST_FROM_BRANCH}" ]; then
+    BRANCH=$(jq --raw-output .ref "${GITHUB_EVENT_PATH}");
-        printf "PULL_REQUEST_FROM_BRANCH is not set, checking branch in payload.\n"
+    BRANCH=$(echo "${BRANCH/refs\/heads\//}")
-        BRANCH=$(jq --raw-output .ref "${GITHUB_EVENT_PATH}");
+    echo "Found branch $BRANCH"
-        BRANCH=$(echo "${BRANCH/refs\/heads\//}")
-    else
-        printf "PULL_REQUEST_FROM_BRANCH is set.\n"
-        BRANCH="${PULL_REQUEST_FROM_BRANCH}"        
-    fi
-
-    # At this point, we must have a branch
-    if [[ "$BRANCH" != "null" ]]; then
-        printf "Found branch $BRANCH to open PR from\n"
-    else
-        printf "No branch in payload, you are required to define PULL_REQUEST_FROM_BRANCH in the environment.\n"
-        exit 1
-    fi
 
     # If it's to the target branch, ignore it
     if [[ "${BRANCH}" == "${PULL_REQUEST_BRANCH}" ]]; then
-        printf "Target and current branch are identical (${BRANCH}), skipping.\n"
+        echo "Target and current branch are identical (${BRANCH}), skipping."
     else
 
         # If the prefix for the branch matches
@@ -139,17 +119,17 @@ main () {
             if [ -z "${PULL_REQUEST_BODY}" ]; then
                 echo "No pull request body is set, will use default."
                 PULL_REQUEST_BODY="This is an automated pull request to update the container collection ${BRANCH}"
+                echo "Pull request body is ${PULL_REQUEST_BODY}"
             fi
-            printf "Pull request body is ${PULL_REQUEST_BODY}\n"
  
             # Pull request title (optional)
             if [ -z "${PULL_REQUEST_TITLE}" ]; then
-                printf "No pull request title is set, will use default.\n"
+                echo "No pull request title is set, will use default."
                 PULL_REQUEST_TITLE="Update container ${BRANCH}"
+                echo "Pull request title is ${PULL_REQUEST_TITLE}"
             fi
-            printf "Pull request title is ${PULL_REQUEST_TITLE}\n"
 
-            create_pull_request "${BRANCH}" "${PULL_REQUEST_BRANCH}" "${PULL_REQUEST_BODY}" "${PULL_REQUEST_TITLE}" "${PULL_REQUEST_DRAFT}"
+            create_pull_request $BRANCH $PULL_REQUEST_BRANCH $PULL_REQUEST_BODY $PULL_REQUEST_TITLE $PULL_REQUEST_DRAFT
 
         fi