Merge pull request #3 from machine-learning-apps/deploy-functionality

Deploy functionality

Author: hamelsmu

.github/workflows/test.yaml

@@ -3,27 +3,94 @@ name: Tests
 on: [push]
 
 jobs:
+  build-temp-container:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      
+      - name: build-temp-container
+        run: |
+          echo ${PASSWORD} | docker login -u $USERNAME --password-stdin
+          docker build -t hamelsmu/chatops:temp -f prebuild.Dockerfile .
+          docker push hamelsmu/chatops:temp
+        env:
+          USERNAME: ${{ secrets.DOCKER_USERNAME }}
+          PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+
   test-static-payload:
+    needs: [build-temp-container]
     runs-on: ubuntu-latest
     steps:
 
       - uses: actions/checkout@master
-        
+      
+      - name: test
+        uses: docker://hamelsmu/chatops:temp
+        env:
+          INPUT_APP_PEM: ${{ secrets.APP_PEM }}
+          INPUT_APP_ID: ${{ secrets.APP_ID }}
+          INPUT_TRIGGER_PHRASE: "/test-trigger-comment"
+          INPUT_INDICATOR_LABEL: "test-label"
+          INPUT_TEST_EVENT_PATH: "tests/pr_comment_payload.json"
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: emit-output
+        uses: docker://hamelsmu/chatops:temp
+        id: nolabel
+        env:
+          INPUT_APP_PEM: ${{ secrets.APP_PEM }}
+          INPUT_APP_ID: ${{ secrets.APP_ID }}
+          INPUT_TRIGGER_PHRASE: "/full-test-run"
+          INPUT_TEST_EVENT_PATH: "tests/pr_comment_stuffed.json"
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: emit-output2
+        uses: docker://hamelsmu/chatops:temp
+        id: nolabel2
+        env:
+          INPUT_APP_PEM: ${{ secrets.APP_PEM }}
+          INPUT_APP_ID: ${{ secrets.APP_ID }}
+          INPUT_TRIGGER_PHRASE: "/something-random-no-trigger"
+          INPUT_TEST_EVENT_PATH: "tests/pr_comment_stuffed.json"
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: test-output
+        run: |
+          import os
+          assert os.getenv('TRAILING_LINE') == "foo bar hello"
+          assert os.getenv('TRAILING_TOKEN') == "foo"
+          assert os.getenv('PULL_REQUEST_NUMBER') == '3'
+          assert os.getenv('BOOL_TRIGGERED') == 'True'
+          assert os.getenv('COMMENTER_USERNAME') == "hamelsmu"
+          assert os.getenv('BRANCH_NAME') == "deploy-functionality"
+          assert os.getenv('BOOL_TRIGGERED_2') == 'False'
+        shell: python
+        env:
+          TRAILING_LINE: ${{ steps.nolabel.outputs.TRAILING_LINE }}
+          TRAILING_TOKEN: ${{ steps.nolabel.outputs.TRAILING_TOKEN }}
+          PULL_REQUEST_NUMBER: ${{ steps.nolabel.outputs.PULL_REQUEST_NUMBER }}
+          BOOL_TRIGGERED: ${{ steps.nolabel.outputs.BOOL_TRIGGERED }}
+          COMMENTER_USERNAME: ${{ steps.nolabel.outputs.COMMENTER_USERNAME }}
+          BRANCH_NAME: ${{ steps.nolabel.outputs.BRANCH_NAME }}
+          BOOL_TRIGGERED_2: ${{ steps.nolabel2.outputs.BOOL_TRIGGERED }}
+
       - name: pre-build action image
         run: |
           cd $GITHUB_WORKSPACE
           echo ${PASSWORD} | docker login -u $USERNAME --password-stdin
-          docker build -t hamelsmu/chatops-workaround -f prebuild.Dockerfile .
-          docker push hamelsmu/chatops-workaround 
+          docker build -t hamelsmu/chatops -f prebuild.Dockerfile .
+          docker push hamelsmu/chatops 
         env:
           USERNAME: ${{ secrets.DOCKER_USERNAME }}
           PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
 
-      - name: test
+      - name: final-test
         uses: ./
         with:
           APP_PEM: ${{ secrets.APP_PEM }}
           APP_ID: ${{ secrets.APP_ID }}
           TRIGGER_PHRASE: "/test-trigger-comment"
           INDICATOR_LABEL: "test-label"
           TEST_EVENT_PATH: "tests/pr_comment_payload.json"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Dockerfile

@@ -1,3 +1,3 @@
-FROM hamelsmu/chatops-workaround
+FROM hamelsmu/chatops
 
 ENTRYPOINT ["python",  "/label_app.py"]

Pipfile

@@ -12,6 +12,8 @@ jwt = "*"
 requests = "*"
 ipykernel = "*"
 jupyter = "*"
+pyjwt = "*"
+ipdb = "*"
 
 [requires]
 python_version = "3.7"

Pipfile.lock

@@ -1,17 +1,11 @@
-![Actions Status](https://github.com/machine-learning-apps/actions-chatops-workaround/workflows/Tests/badge.svg)
+![Actions Status](https://github.com/machine-learning-apps/actions-chatops/workflows/Tests/badge.svg)
 
 # Trigger Actions With ChatOps via PR Labels or Deployements
 
-This action helps you trigger downstream actions with a custom command made via a comment in a pull request, otherwhise known as [ChatOps](https://www.pagerduty.com/blog/what-is-chatops/). This Action is similar to [this chatops action](https://github.com/machine-learning-apps/actions-chatops), except that this Action can defer to GitHub App to (1) Make labels on a PR or (2) Create a [Deployment](https://developer.github.com/v3/repos/deployments/#create-a-deployment).  The reasons you might want to do this are the following:  
 
-- By deferring to a GitHub App to create a pull request label or a deployment event, you can trigger a downstream GitHub Action that runs in the context of a pull request.  The reason for using a GitHub App is Actions cannot trigger other Actions.  
-- It can be important to run in the context of a pull request as that is the only way you will see [Check Runs](https://developer.github.com/v3/checks/runs/) for your pull request, so you can monitor the status of your workflows.   
-  - Note that comments on PRs [triggers Actions workflows on the default branch](https://help.github.com/en/articles/events-that-trigger-workflows#issue-comment-event-issue_comment) which is not desireable for ChatOps most of the time.  This Action resolves this issue by piggybacking on a GitHub app to create an event that will trigger Actions workflows on the pull request's branch instead.
-- This can prevent you from accidentally executing the chatops command twice as the label event will not fire if the PR is already labeled or the deployment has already been created.
+This action helps you trigger downstream actions with a custom command made via a comment in a pull request, otherwhise known as [ChatOps](https://www.pagerduty.com/blog/what-is-chatops/).  
 
-Therefore, one of the required inputs is the secret key `APP_PEM` for authenticating as a GitHub App which has the following permissions:
-- [Deployment](https://developer.github.com/v3/apps/permissions/#permission-on-deployments): read & write
-- [Pull Requests](https://developer.github.com/v3/apps/permissions/#permission-on-pull-requests): read & write
+Optionally, you may provide credentials to authenticate as a GitHub App and label an issue once a trigger phrase is detected.  Having another app other than the GitHub Action apply a label allows you to create a label event to trigger downstream Actions (since an Action cannot create events that trigger other Actions).
 
 
 ## Example Usage
@@ -24,17 +18,34 @@ jobs:
   label-pr:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@master
-      - name: test
-        uses: machine-learning-apps/actions-chatops-workaround@master
+      - name: listen for PR Comments
+        uses: machine-learning-apps/actions-chatops@master
         with:
           APP_PEM: ${{ secrets.APP_PEM }}
           APP_ID: ${{ secrets.APP_ID }}
           TRIGGER_PHRASE: "/test-trigger-comment"
           INDICATOR_LABEL: "test-label"
+        env: # you must supply GITHUB_TOKEN
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+        # This step clones the branch of the PR associated with the triggering phrase, but only if it is triggered.
+      - name: clone branch of PR
+        if: steps.prcomm.outputs.TRIGGERED == 'true'
+        uses: actions/checkout@master
+        with:
+          ref: ${{ steps.prcomm.outputs.SHA }}
+
+        # This step is a toy example that illustrates how you can use outputs from the pr-command action
+      - name: print variables
+        if: steps.prcomm.outputs.TRIGGERED == 'true'
+        run: echo "${USERNAME} made a triggering comment on PR# ${PR_NUMBER} for ${BRANCH_NAME}"
+        env: 
+          BRANCH_NAME: ${{ steps.prcomm.outputs.BRANCH_NAME }}
+          PR_NUMBER: ${{ steps.prcomm.outputs.PULL_REQUEST_NUMBER }}
+          USERNAME: ${{ steps.prcomm.outputs.COMMENTER_USERNAME }}
 ```
 
-A demonstration of this in action can be found on [this PR](https://github.com/machine-learning-apps/actions-chatops-workaround/pull/2).
+A demonstration of this in action can be found on [this PR](https://github.com/machine-learning-apps/actions-chatops/pull/2).
 
 ## Mandatory Inputs
 
@@ -52,9 +63,27 @@ A demonstration of this in action can be found on [this PR](https://github.com/m
 
   - `INDICATOR_LABEL`:
     - description: label that wil be added to the PR if a triggering comment is detected.  This is used to trigger downstream Actions with the right context of the PR.
-    - required: true
+    - required: false
+    - default: ""
 
   - `TEST_EVENT_PATH`:
     - description: An alternate place to fetch the payload for testing and debugging when making changes to this Action.  This is set to they system environment variable $GITHUB_EVENT_PATH by default.
     - require: false
-    default: ""
+    - default: ""
+
+
+## Outputs
+
+ - `TRAILING_LINE:`: the text that immediately follows the triggering phrase that is on the same line.  For example,  "/trigger-phrase foo bar\n next line" will emit the value "foo bar" This is intended to be used as arguments for downstream actions.
+
+ - `TRAILING_TOKEN:`: this is the next token that immediately follows the triggering phrase that is on the same line.  For example,  "/trigger-phrase foo bar" will emit the value "foo". This is intended to be used as arguments for downstream actions.
+
+ - `PULL_REQUEST_NUMBER`: the number of the pull request
+
+ - `COMMENTER_USERNAME`: The GitHub username of the person that made the triggering comment in the PR.
+
+ - `BRANCH_NAME`: The name of the branch corresponding to the PR.
+
+ - `SHA`: The SHA of the branch on the PR at the time the triggering comment was made.
+
+ - `BOOL_TRIGGERED`: true or false depending on if the trigger phrase was detected and this is a pull request.

README.md

@@ -1,10 +1,10 @@
-name: 'ChatOps Via PR Labels'
-description: Trigger PR labels with chatops and a GitHub App, which is a work-around to trigger downstream Actions with the right context.
+name: 'ChatOps For Actions'
+description: Listen for special comments, or chatops commands in the comments of a PR.
 author: Hamel Husain
 inputs:
   APP_PEM:
     description: string version of your PEM file used to authenticate as a GitHub App
-    required: true
+    required: false
   APP_ID:
     description: you GITHUB App ID.
     required: true
@@ -13,13 +13,29 @@ inputs:
     required: true
   INDICATOR_LABEL:
     description: label that wil be added to the PR if a triggering comment is detected.  This is used to trigger downstream Actions with the right context of the PR.
-    required: true
+    required: false
+    default: ""
   TEST_EVENT_PATH:
     description: An alternate place to fetch the payload for testing and debugging when making changes to this Action.  This is set to they system environment variable $GITHUB_EVENT_PATH by default.
     require: false
     default: ""
+outputs:
+  TRAILING_LINE:
+    description: the text that immediately follows the triggering phrase that is on the same line.  For example,  "/trigger-phrase foo bar\n next line" will emit the value "foo bar" This is intended to be used as arguments for downstream actions.
+  TRAILING_TOKEN:
+    description: this is the next token that immediately follows the triggering phrase that is on the same line.  For example,  "/trigger-phrase foo bar" will emit the value "foo". This is intended to be used as arguments for downstream actions.
+  BOOL_TRIGGERED:
+    description: true or false depending on if the trigger phrase was detected and this is a pull request.
+  PULL_REQUEST_NUMBER:
+    description: the number of the pull request
+  COMMENTER_USERNAME:
+    description: The GitHub username of the person that made the triggering comment in the PR.
+  BRANCH_NAME:
+    description: The name of the branch corresponding to the PR.
+  SHA:
+    description: The SHA of the branch on the PR at the time the triggering comment was made.
 branding:
-  color: 'blue'
+  color: 'gray-dark'
   icon: 'message-square'
 runs:
   using: 'docker'

action.yml

@@ -1,18 +1,18 @@
 #!/bin/bash
-docker build -t hamelsmu/chatops-workaround -f prebuild.Dockerfile .
+docker build -t hamelsmu/chatops -f prebuild.Dockerfile .
 
-INPUT_TRIGGER_PHRASE="making"
+INPUT_TRIGGER_PHRASE="/test-trigger-comment"
 INPUT_INDICATOR_LABEL="test-successfull"
 TEST_EVENT_PATH="tests/pr_comment_payload.json"
 GITHUB_REPOSITORY="machine-learning-apps/actions-ml-cicd"
 
-docker push hamelsmu/chatops-workaround
+docker push hamelsmu/chatops
 
 docker run \
 -e INPUT_TRIGGER_PHRASE=$INPUT_TRIGGER_PHRASE \
 -e INPUT_INDICATOR_LABEL="$INPUT_INDICATOR_LABEL" \
 -e INPUT_APP_PEM="${INPUT_APP_PEM}" \
 -e INPUT_APP_ID="$INPUT_APP_ID" \
--e INPUT_TEST_EVENT_PATH="${GITHUB_EVENT_PATH}" \
+-e INPUT_TEST_EVENT_PATH="${TEST_EVENT_PATH}" \
 -e GITHUB_REPOSITORY="$GITHUB_REPOSITORY" \
-hamelsmu/chatops-workaround
+hamelsmu/chatops