adding more responses

Author: mattdavis0351

config.yml

@@ -6,13 +6,20 @@ template:
   repo: write-github-script-template
   name: write-github-script
 before:
+  - type: updateBranchProtection
   - type: createIssue
     title: Start here!
-    body: 01_welcome-issue.md
+    body: 00_welcome-issue.md
     action_id: welcomeIssue
   - type: respond
+    with: 00_explain-gh-script.md
     issue: "%actions.welcomeIssue.data.number%"
-    with: 01_welcome-activity.md
+  - type: respond
+    with: 00_octokit-comparison.md
+    issue: "%actions.welcomeIssue.data.number%"
+  - type: respond
+    issue: "%actions.welcomeIssue.data.number%"
+    with: 00_welcome-activity.md
     data:
       quicklink: "%payload.repository.html_url%/new/master?filename=.github/workflows/my-workflow.yml&workflow_template=blank"
       actionsUrl: "%payload.repository.html_url%/actions/new"
@@ -21,7 +28,7 @@ steps:
   - title: Setup a workflow file
     description: Create a pull request to add a workflow
     event: pull_request
-    link: "{{ repoUrl }}/issues/%payload.pull_request.number%"
+    link: "{{ repoUrl }}/issues/1"
     actions:
       - type: gate
         gates:
@@ -82,52 +89,43 @@ steps:
           pullUrl: "%payload.pull_request.html_url%"
       - type: closeIssue
         issue: Start here!
+      - type: removeBranchProtection
       - type: respond
-        with: 01_explain-workflow.md
+        with: 01_merg-workflow.md
         data:
           actionsUrl: "%payload.repository.html_url%/actions"
-      - type: respond
-        with: 02_modify-workflow.md
-        data:
-          workflowFile: "%payload.repository.html_url%/edit/%payload.pull_request.head.ref%/.github/workflows/my-workflow.yml"
 
   - title: Open an issue to trigger GitHub Script workflow
     description: Use GitHub script to comment when an issue is opened
-    event: pull_request.synchronize
-    link: "{{ repoUrl }}/issues/%payload.pull_request.number%"
+    event: pull_request.closed
+    link: "{{ repoUrl }}/pull/2"
+    actions:
+      - type: updateBranchProtection
+      - type: createIssue
+        title: Create an issue comment
+        body: 02_workflow-triggered.md
+        action_id: triggerIssue
+      - type: respond
+        with: new-issue.md
+        issue: Create my-workflow.yml
+        data:
+          issueURL: "%actions.triggerIssue.data.html_url%"
+
+  - title: The workflow has commented
+    description: a response after the workflow has run
+    event: check_suite.completed
+    link: "{{repoUrl}}/issues/3"
     actions:
-      #######################################################
-      # Validate the filepath for the my-workflow.yml file
-      # get tree
-      - type: getTree
-        action_id: isInTree
-        recursive: true
-        sha: "%payload.pull_request.head.sha%"
-      # check for a file in a tree
       - type: gate
-        left: "%actions.isInTree.data.tree%"
-        operator: includes
-        right: "path:.github/workflows/my-workflow.yml"
+        left: "%payload.check_suite.app.name%"
+        operator: ===
+        right: "GitHub Actions"
         else:
-          # if file isn't where expected find true location
-          - type: findInTree
-            path: my-workflow.yml
-            tree: "%actions.isInTree.data.tree%"
-            # multiple: true
-            action_id: fileLocation
-          # help user with proper file location
           - type: respond
-            with: e-wrong-file-location.md
+            issue: Create an issue comment
+            with: debug.md
             data:
-              haveFile: "%actions.fileLocation.path%"
-              needFile: ".github/actions/cat-facts/action.yml"
-              editLink: "%payload.repository.html_url%/edit/%payload.pull_request.head.ref%/%actions.fileLocation.path%"
-              fileName: my-workflow.yml
-        # End filepath verification
-        #######################################################
+              debug: "%payload%"
       - type: respond
-        with: 03_create-an-issue.md
-        data:
-          pullUrl: "%payload.pull_request.html_url%"
-          actionsUrl: "%payload.repository.html_url%/actions"
-          workflowFile: "%payload.repository.html_url%/edit/%payload.pull_request.head.ref%/.github/workflows/my-workflow.yml"
+        with: 03_workflow-success.md
+        issue: Create an issue comment

responses/00_explain-gh-script.md

@@ -0,0 +1,64 @@
+## Create an issue comment
+
+If we take a look at the [Octokit documentation](https://octokit.github.io/rest.js/v17#issues-create-comment) on how to create issue comments we we are greeted with the following method:
+
+**someFile.js**
+
+```javascript
+octokit.issues.createComment({
+  owner,
+  repo,
+  issue_number,
+  body
+});
+```
+
+Okay, that doesn't seem so hard. Now that we know how to do it with Octokit let's take a look at how to use GitHub Script to create an issue comment:
+
+**my-workflow.yml**
+
+```yaml
+- uses: actions/github-script@0.8.0
+  with:
+    github-token: ${{secrets.GITHUB_TOKEN}}
+    script: |
+    github.issues.createComment({
+        issue_number: context.issue.number,
+        owner: context.repo.owner,
+        repo: context.repo.repo,
+        body: '👋 Thanks for reporting!'
+    })
+```
+
+## Open a pull request
+
+Now let's examine what it's like to open a pull request with octokit/rest.js:
+
+**someFile.js**
+
+```javascript
+octokit.pulls.create({
+  owner,
+  repo,
+  title,
+  head,
+  base
+});
+```
+
+Again, that's not too hard at all. Now let's do the same thing, only using the GitHub Script action:
+
+```yml
+- uses: actions/github-script@0.8.0
+  with:
+    github-token: ${{secrets.GITHUB_TOKEN}}
+    script: |
+    github.pull.create({
+        repo: github.context.repo.repo,
+        owner: github.context.repo.owner,
+        head: github.context.ref,
+        base: "master",
+        title: "from my action",
+        body: "## I totally used GitHub Script to pull this off 🔥"
+    })
+```

responses/00_octokit-comparison.md

@@ -0,0 +1,19 @@
+## That's not much different, so why might I want to use GitHub Script?
+
+With GitHub Script you don't have to worry about
+
+- Building a custom action to create this issue comment.
+- No Octokit dependencies to worry about.
+- No additional packages to manage.
+- No need to write action metadata.
+- No need to write source code to handle this Octokit method.
+
+Using GitHub Script instead of writing custom actions for repository related tasks can prove to be a much more light-weight solution in most cases.
+
+Anything you can do with Octokit can be accomplished with GitHub Script 🎉!
+
+---
+
+_You may have noticed that when using GitHub Script the method call starts with `github` and not `octokit`. This is because GitHub Script provides you with a pre-authenticated octokit/rest.js client stored in a variable named `github`._
+
+_`context` is a reference to an object containing the [context of the current workflow run](https://github.com/actions/toolkit/blob/master/packages/github/src/context.ts)_

responses/00_welcome-activity.md

@@ -0,0 +1,65 @@
+## Configuring a workflow
+
+Actions are enabled on your repository by default, but we still have to tell our repository to use them. We do this by creating a workflow file in our repository.
+
+If you've been following the learning path for GitHub Actions then this task is quite familiar to you.
+
+<details><summary>Brand new to GitHub Actions?  Click here to learn about workflows!</summary>
+
+#### What is a workflow file?
+
+A **workflow** file can be thought of as the recipe for automating a task. They house the start to finish instructions, in the form of `jobs` and `steps`, for what should happen based on specific triggers.
+
+Your repository can contain multiple **workflow** files that carry out a wide variety of tasks. It is important to consider this when deciding on a name for your **workflow**. The name you choose should reflect the tasks being performed.
+
+</details>
+
+<br>
+
+<!-- 💻 Actively learn about workflows by enrolling in [this Learning Lab course which has no name or content yet]() -->
+
+📖 Read more about [workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/configuring-a-workflow#choosing-the-type-of-actions-for-your-workflow)
+
+### :keyboard: Activity: Respond to an issue when it get's opened
+
+1. Create a new workflow file titled `.github/workflows/my-workflow.yml` with the following contents:
+   You can use [this quicklink]({{quicklink}}) to easily create this file
+
+   ```yaml
+   name: Learning GitHub Script
+
+   on:
+     issues:
+       types: [opened]
+
+   jobs:
+     comment:
+       runs-on: ubuntu-latest
+       steps:
+         - 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!!!"
+               })
+   ```
+
+1. Commit the workflow to a new branch.
+1. Create a pull request titled **Create my-workflow.yml**.
+1. Supply the pull request body content and click `Create pull request`.
+
+_It is important to place meaningful content into the body of the pull requests you create throughout this course. This repository will stay with you long after you complete the course. It is advisable that you use the body of the pull requests you create as a way to take long lived notes about thing you want to remember._
+
+<details><summary>Suggested body content</summary>
+
+`Workflow files are the recipe for task automation. This is where actions are placed if I want to use them for a task.`
+
+</details>
+
+---
+
+I'll respond in the new pull request when I detect it has been created.

responses/00_welcome-issue.md

@@ -0,0 +1,17 @@
+# Hi there 👋!
+
+Hello @{{user.login}}, I'm so excited to teach you how to use GitHub Script in your workflows 😄
+
+## What is GitHub Script?
+
+<p align="center">
+<img src="https://user-images.githubusercontent.com/38021615/76347761-5ce75d00-62c4-11ea-835b-35660b5188c8.png" alt="octokit logo" height=200/>
+</p>
+
+[GitHub Script](https://github.com/actions/github-script) is a really awesome action that allows you to quickly interact with the GitHub API directly in your workflow!
+
+This allows you to use the workflow context to script any API usage that is available through the octokit/rest.js library without the need to build a bulky custom action to do so.
+
+📖 See [octokit/rest.js](https://octokit.github.io/rest.js/) for the API client documentation.
+
+Let's take a closer look at how this action compares to Octokit.

responses/01_explain-workflow.md

@@ -0,0 +1,17 @@
+## You have triggered a workflow!
+
+Great job @{{user.login}}, you successfully added a workflow to this repository 🎉!
+
+Since this workflow has a trigger that pertains to the repository as a whole, rather than just this branch, we will need to merge this pull request before we can start using it.
+
+Let's go ahead and do this now.
+
+### :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!
+
+Oh, I'll also be responding to you from that issue!