adding more steps

Author: mattdavis0351

config.yml

@@ -130,7 +130,7 @@ steps:
         right: "GitHub Actions"
         else:
           - type: respond
-            issue: Create an issue comment with GitHub Script
+            issue: 3
             with: debug.md
             data:
               debug: "%payload%"
@@ -240,3 +240,85 @@ steps:
         issue: Update my-workflow.yml
         data:
           issueURL: "%actions.triggerIssue.data.html_url%"
+
+  - title: Break your workflow into multiple steps
+    description: Separate the workflow concerns by adding more steps
+    event: check_suite.completed
+    link: "{{repoUrl}}/issues/5"
+    actions:
+      - type: gate
+        left: "%payload.check_suite.app.name%"
+        operator: ===
+        right: "GitHub Actions"
+        else:
+          - type: respond
+            issue: 5
+            with: debug.md
+            data:
+              debug: "%payload%"
+      - type: octokit
+        method: projects.listForRepo
+        owner: "%payload.repository.owner.login%"
+        repo: "%payload.repository.name%"
+        action_id: projectBoard
+      - type: octokit
+        method: projects.listColumns
+        project_id: "%actions.projectBoard.data.0.id%"
+        action_id: listColumns
+      - type: respond
+        with: 06_steps-overview.md
+        data:
+          projectTab: "%payload.repository.html_url%/projects/1"
+      - type: respond
+        with: 06_steps-activity.md
+        data:
+          listProj: "%actions.projectBoard.data%"
+          listCol: "%actions.listColumns.data%"
+          columnID: "%actions.listColumns.data.0.id%"
+          quicklink: "%payload.repository.html_url%/edit/master/.github/workflows/my-workflow.yml"
+          actionsTab: "%paylaod.repository.html_url%/actions"
+
+  - title: Create better comments
+    description: Use a templated repsonse as the comment body
+    event: pull_request
+    link: "{{repoUrl}}/pull/6"
+    actions:
+      - type: respond
+        with: 07_explain-node.md
+      - type: respond
+        with: 07_use-fs.md
+        data:
+          quicklink: "%payload.repository.html_url%/edit/%payload.head.ref%/.github/workflows/my-workflow.yml"
+
+  - title: Merge the final workflow
+    description: Merge the final workflow into the repository
+    event: pull_request.synchronize
+    link: "{{repoUrl}}/pull/6"
+    actions:
+      - type: removeBranchProtection
+      - type: respond
+        with: 08_merge-workflow.md
+
+  - title: Course recap
+    description: Final remarks on course content
+    event: pull_request.closed
+    link: "{{repoUrl}}/issue/7"
+    actions:
+      - type: octokit
+        method: issues.create
+        owner: "%payload.repository.owner.login%"
+        repo: "%payload.repository.name%"
+        title: It's alive!
+        body: |
+          ## Great Job so far!  
+
+          Like before, now we have to wait for the
+          workflow to run so that we can see the results.  I'll respond here once it has completed!
+        labels: ["bug"]
+      - type: respond
+        with: 09_workflow-completed.md
+        issue: It's alive!
+      # - type: createIssue
+      #   title: It's alive!
+      #   body: 09_workflow-triggered
+      #   action_id: triggerIssue

responses/03_add-to-projects.md

@@ -20,11 +20,11 @@ We've gone ahead and done this on our end of things so that we could give you th
    name: Learning GitHub Script
 
    on:
-   issues:
+     issues:
        types: [opened]
 
    jobs:
-   comment:
+     comment:
        runs-on: ubuntu-latest
        steps:
        - uses: actions/github-script@0.8.0

responses/06_steps-activity.md

@@ -0,0 +1,55 @@
+# Add steps for each action
+
+We will make the following changes to the current workflow file:
+
+- Name each step so we can easily keep track of it in the [actions tab]({{actionTab}})
+- Use expressions to determine `if` a step should execute
+
+### :keyboard: Activity: Add newly opened issue to project board
+
+1. [Edit]({{quicklink}}) the current workflow `.github/workflows/my-workflow.yml` to have he following contents:
+
+   ```yaml
+   name: Learning GitHub Script
+
+   on:
+     issues:
+       types: [opened]
+
+   jobs:
+     comment:
+       runs-on: ubuntu-latest
+       steps:
+       - name: Comment on new issue
+         uses: actions/github-script@0.8.0
+         with:
+           github-token: {% raw %}${{secrets.GITHUB_TOKEN}}{% endraw %}
+           script: |
+               github.issues.createComment({
+               issue_number: context.issue.number,
+               owner: context.repo.owner,
+               repo: context.repo.repo,
+               body: "🎉 You've created this issue comment using GitHub Script!!!"
+               })
+
+       - name: Add issue to project board
+         if: contains(github.event.issue.labels.*.name, 'bug')
+         uses: actions/github-script@0.8.0
+         with:
+           github-token: {% raw %}${{secrets.GITHUB_TOKEN}}{% endraw %}
+           script: |
+               github.projects.createCard({
+               column_id: {{columnID}},
+               content_id: context.payload.issue.id,
+               content_type: "Issue"
+               });
+
+   ```
+
+2. Commit the workflow to a new branch.
+3. Create a pull request titled **Update my-workflow.yml**.
+4. Supply the pull request body content and click `Create pull request`.
+
+---
+
+I'll respond in the pull request you create

responses/06_steps-overview.md

@@ -0,0 +1,15 @@
+## Let's improve the workflow
+
+@{{user.login}} it looks like you workflow has completed! Let's take a look at the results!
+
+We should be pretty familiar with the first portion of the workflow, it's the same as the first time it ran, and it just creates a comment whenever a new issue has been created.
+
+The second portion may exactly be clear to you, but this issue was added to a project board that is present in this repository. Checkout the [projects tab]({{projectTab}}) if you want to see that this issue has been added!
+
+#### Multiple steps
+
+One benefit of using actions is the ability to separate `jobs` into smaller units of work called `steps`. If we think about what our workflow is doing we can see that it makes more sense to have these two tasks take place across two steps.
+
+As an added advantage, once we break the current workflow into multiple steps we can apply logic through expressions to them. This will let us create rules around when steps are allowed to run. Ultimately this allows us to optimize our workflow run!
+
+Since GitHub Script is simply an action, breaking each unique task into a new step works just fine! We will do this in our next activity!

responses/07_explain-node.md

@@ -0,0 +1,11 @@
+# Improving the issue comment
+
+💡Did you know that GitHub Script also grants you access to a full Node.js environment?
+
+Although we wouldn't recommend using GitHub Script to write the logic for complex actions, there are use cases where you may want to leverage using a little more than just the octokit/rest.js API.
+
+One such use case is our issue comment. Right now it is pretty hard coded the way it is making it less than ideal. What if we wanted to display our contribution guide every time an issue was opened?
+
+Instead of writing the guide directly into our workflow, we can use the Node.js File System module to read a file and use it as the body of our issue comment.
+
+If we want access to the files within our repository, we need to make sure we include the `actions/checkout` action in our workflow as the first step.

responses/07_use-fs.md

@@ -0,0 +1,58 @@
+## Use the FS module to use a templated comment
+
+We will make the following changes to the current workflow file:
+
+- Add the `actions/checkout` action so we can read the templated response file located at `.github/ISSUE_RESPONSES/comment.md`
+- Add JavaScript to use the Node.js File System module to place the contents of our templated response as the body of the issue comment.
+
+### :keyboard: Activity: Add newly opened issue to project board
+
+1. [Edit]({{quicklink}}) the current workflow to have he following contents:
+
+   ```yaml
+   name: Learning GitHub Script
+
+   on:
+     issues:
+       types: [opened]
+
+   jobs:
+     comment:
+       runs-on: ubuntu-latest
+       steps:
+         - name: Checkout repo
+           uses: actions/checkout@v2
+
+         - name: Comment on new issue
+           uses: actions/github-script@0.8.0
+           with:
+             github-token: {% raw %}${{secrets.GITHUB_TOKEN}}{% endraw %}
+             script: |
+                const fs = require('fs')
+                const issueBody = fs.readFileSync(".github/ISSUE_RESPONSES/comment.md", "utf8")
+                github.issues.createComment({
+                issue_number: context.issue.number,
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                body: issueBody
+                })
+
+         - name: Add issue to project board
+           if: contains(github.event.issue.labels.*.name, 'bug')
+           uses: actions/github-script@0.8.0
+           with:
+             github-token: {% raw %}${{secrets.GITHUB_TOKEN}}{% endraw %}
+             script: |
+               github.projects.createCard({
+               column_id: {{columnID}},
+               content_id: context.payload.issue.id,
+               content_type: "Issue"
+               });
+
+   ```
+
+2. Commit the workflow changes to this branch.
+
+---
+
+I'll respond once you've committed the changes to this branch

responses/08_merge-workflow.md

@@ -0,0 +1,13 @@
+## Time to see the magic in action!
+
+@{{user.login}}, All of the necessary changes have been made, and our workflow now contains enough information to be quite awesome!
+
+### :keyboard: Activity: Merge the workflow
+
+When you are ready, merge this pull request.
+
+---
+
+Once you have merged this pull request I will open a new issue so we can see this workflow in action!
+
+<details><summary>Trouble merging?</summary>Try refreshing the page!</details>

responses/09_workflow-completed.md

@@ -0,0 +1 @@
+# super awesome workflow has been triggered