Merge pull request #7 from githubtraining/matt-revisions

Revise response content

Author: mattdavis0351

config.yml

@@ -8,18 +8,27 @@ template:
   name: "writing-javascript-actions"
 before:
   - type: updateBranchProtection
+  - type: createLabel
+    name: first-joke
+    color: FFBD33
+  - type: createLabel
+    name: second-joke
+    color: 33FFBD
+  - type: createLabel
+    name: third-joke
+    color: 3F8A99
   - type: createIssue
     title: Start here!
     body: 01_welcome-issue.md
     action_id: welcomeIssue
   - type: respond
-    issue: '%actions.welcomeIssue.data.number%'
+    issue: "%actions.welcomeIssue.data.number%"
     with: 01_welcome-activity.md
     data:
-      quicklink: '%payload.repository.html_url%/new/master?filename=.github/workflows/my-workflow.yml&workflow_template=blank'
+      quicklink: "%payload.repository.html_url%/new/master?filename=.github/workflows/my-workflow.yml&workflow_template=blank"
       actionsUrl: "%payload.repository.html_url%/actions/new"
 steps:
-  - title: Prepare the repository
+  - title: Setup a workflow file
     description: Create a pull request to add a workflow
     event: pull_request
     link: "{{ repoUrl }}/issues/1"
@@ -33,18 +42,18 @@ steps:
           - left: "%payload.action%"
             operator: ===
             right: edited
-            # AND the pull request title equals 'Initial workflow'
+            # AND the pull request title equals 'Create my-workflow.yml'
       - type: gate
         left: "%payload.pull_request.title%"
         operator: ===
-        right: Initial workflow
+        right: Create my-workflow.yml
 
         # if those statments FAIL... do this
         else:
           - type: respond
             with: e-rename-pr.md
             data:
-              title: Initial workflow
+              title: Create my-workflow.yml
           # if those gates === true Then do this stuff
       - type: closeIssue
         issue: Start here!
@@ -66,17 +75,23 @@ steps:
         left: "%payload.check_suite.app.name%"
         operator: ===
         right: "GitHub Actions"
+        else:
+          - type: respond
+            issue: Initial workflow
+            with: debug.md
+            data:
+              debug: "%payload%"
       - type: respond
         with: 02_workflow-results.md
-        issue: Initial workflow
+        issue: Create my-workflow.yml
         data:
           actionsUrl: "%payload.repository.html_url%/actions"
       - type: getPullRequest
-        pullRequest: Initial workflow
+        pullRequest: Create my-workflow.yml
         action_id: iwPr
       - type: respond
         with: 02_modify-workflow.md
-        issue: Initial workflow
+        issue: Create my-workflow.yml
         data:
           workflowFile: "%payload.repository.html_url%/edit/%actions.iwPr.data.head.ref%/.github/workflows/my-workflow.yml"
 
@@ -86,7 +101,7 @@ steps:
     link: "{{ repoUrl }}/pull/2"
     actions:
       - type: getPullRequest
-        pullRequest: Initial workflow
+        pullRequest: Create my-workflow.yml
         action_id: workflowPr
       - type: respond
         with: 03_reference-actions.md
@@ -98,15 +113,15 @@ steps:
     event: pull_request.synchronize
     actions:
       - type: createIssue
-        title: Setting up your development environment
+        title: Your first JavaScript action
         body: dev-env.md
         action_id: devEnv
       - type: createReview
         event: APPROVE
         body: 04_on-to-actions.md
         data:
           issueUrl: "%actions.devEnv.data.html_url%"
-        pullRequest: Initial workflow
+        pullRequest: Create my-workflow.yml
       - type: mergePullRequest
 
   - title: Creating the Action metadata
@@ -124,18 +139,23 @@ steps:
         right: true
       - type: createPullRequest
         title: Hello Action
-        body: 05_explain-metadata.md
+        body: 05_explain-actions.md
         head: hello-world
         action_id: helloPr
         data:
           actionsUrl: "%payload.repository.html_url%/actions"
       - type: respond
         with: 05_hello-pr.md
-        issue: Setting up your development environment
+        issue: Your first JavaScript action
         data:
           pullUrl: "%actions.helloPr.data.html_url%"
       - type: closeIssue
-        issue: Setting up your development environment
+        issue: Your first JavaScript action
+      - type: respond
+        with: 05_explain-metadata.md
+        issue: Hello Action
+        data:
+          actionsUrl: "%payload.repository.html_url%/actions"
       - type: respond
         with: 05_create-metadata.md
         issue: Hello Action
@@ -216,7 +236,7 @@ steps:
           - left: "%payload.action%"
             operator: ===
             right: edited
-            # AND the pull request title equals 'Initial workflow'
+            # AND the pull request title equals 'Create my-workflow.yml'
       - type: gate
         left: "%payload.pull_request.title%"
         operator: ===
@@ -317,7 +337,7 @@ steps:
           - left: "%payload.action%"
             operator: ===
             right: edited
-            # AND the pull request title equals 'Initial workflow'
+            # AND the pull request title equals 'Create my-workflow.yml'
       - type: gate
         left: "%payload.pull_request.title%"
         operator: ===

course-details.md

@@ -2,5 +2,15 @@
 
 Over the duration of this course, approximately 1 hour, you will learn the skills needed to begin using and customizing GitHub Actions in your unique workflow scenarios.
 
-**prerequisites**
-It would be very beneficial to you to have JavaScript or other programming familiarity before enrolling in this course.
+**Prerequisites**
+
+We will be using Node.js to build our action and GitHub to consume our action. This presents us with a hybrid environment, the Node.js runtime environment and the virtual machine used by GitHub Actions, that you may not be used to if you've taken other Learning Lab courses.
+
+Before we can get started there are a few things you need to setup on your **local machine**
+
+1. Install [Node.js](https://nodejs.org/en/) for your operating system.
+2. Ensure you have a text editor installed. I'll be using Visual Studio Code, and although you are free to use your editor of choice you should be aware that using a different editor will result in your screen not matching my examples. Here are some editor options for you:
+   1. [Visual Studio Code](https://code.visualstudio.com/) **(recommended)**
+   2. [Atom](https://atom.io/)
+   3. [Sublime Text](https://www.sublimetext.com/)
+3. Lastly, you're going to need a local installation of [Git](https://git-scm.com/) so that you can interact with this repository as you write code.

responses/01_explain-environment.md

@@ -23,9 +23,9 @@ When a repository is configured with a **workflow** file, like we just created,
 
 1.  Your GitHub repository listens for an event
 2.  That event triggers a workflow run which starts a runner
-3.  The runner, regardless of the hosting method, is responsible for carrying out the jobs which are defined.
+3.  The runner, regardless of the hosting method, is responsible for carrying out the jobs which are defined
 4.  A job is series of steps, which can be actions or commands
-5.  When the steps complete a report is generated and can be viewed by anyone with access to the repository.
+5.  When the steps complete a report is generated and can be viewed by anyone with access to the repository
 
 
 

responses/01_explain-syntax.md

@@ -1,6 +1,6 @@
 ## Go on... Tell me more!
 
-I'm glad you asked.  Let's take a look at the workflow file that we just committed to this repository.
+I'm glad you asked. Let's take a look at the workflow file that we just committed to this repository.
 
 ```yaml
 name: CI
@@ -9,47 +9,46 @@ on: [push]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
-    - name: Run a one-line script
-      run: echo Hello, world!
-    - name: Run a multi-line script
-      run: |
-        echo Add other actions to build,
-        echo test, and deploy your project.
+      - uses: actions/checkout@v1
+      - name: Run a one-line script
+        run: echo Hello, world!
+      - name: Run a multi-line script
+        run: |
+          echo Add other actions to build,
+          echo test, and deploy your project.
 ```
 
 This file is made up of a series of metadata, as well as behaviors that we wish to happen when the workflow is triggered.
 
 Let's take a second to talk about each of the pieces that we see here:
 
 - `name: CI`
-  - This is the user-defined name for the workflow.  This shows up on the Actions tab so we can see which workflows, and their statuses, run on this repository.
-  - ![](https://i.imgur.com/KIFh6kk.png)
+  - This is the user-defined name for the workflow. This shows up on the Actions tab so we can see which workflows, and their statuses, run on this repository.
   - As you can see, our's is currently named `CI`
 - `on: [push]`
-  - This defines the **event** that will tigger a workflow on this repository.  Currently we are listening for any [push event](https://developer.github.com/v3/activity/events/types/#pushevent) that happens within this repository.
+  - This defines the **event** that will tigger a workflow on this repository. Currently we are listening for any [push event](https://developer.github.com/v3/activity/events/types/#pushevent) that happens within this repository.
   - Also note that this is an array, which means we can trigger this workflow [on more than one event](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#about-workflow-events) if that is our intended behavior.
 - `Jobs:`
-  - This is our first block of instructions.  We are defining our first job for this workflow.
+  - This is our first block of instructions. We are defining our first job for this workflow.
   - In this case, the job has been named `build`
   - We also define the runner for the job as `runs-on: ubuntu-latest`
-  - Finally we define the steps for this job which can either rely on specific actions, or run commands directly.  As we can see there are three steps which show a mixed usage of actions and commands.
+  - Finally we define the steps for this job which can either rely on specific actions, or run commands directly. As we can see there are three steps which show a mixed usage of actions and commands.
     - `uses: actions/checkout@v1`
     - ```
       name: Run a one-line script
       run: echo Hello, world!
+      ```
     - ```
       name: Run a multi-line script
       run: |
         echo Add other actions to build,
         echo test, and deploy your project.
-        ```
+      ```
 
 ---
 
+📖Take a deeper dive into [workflow components](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/configuring-workflows)
 📖Read more about [configuring workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/configuring-workflows)
-    

responses/01_explain-workflow.md

@@ -1,12 +1,8 @@
-## Workflow success!
+## While we wait!
 
-Great job adding the workflow. Adding that file to this branch is enough for GitHub Actions to begin running on your repository. The time this takes will vary based on the complexity of the workflow.  While this runs I'll briefly explain the components of the workflow you just added.
+Great job adding the workflow. Adding that file to this branch is enough for GitHub Actions to begin running on your repository. The time this takes will vary based on the complexity of the workflow. While this runs I'll briefly explain the components of the workflow you just added.
 
-📖Take a deeper dive into [workflow components](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/configuring-workflows)
-
-
-
-I'll respond when GitHub Actions finishes running the workflow. You can follow along in the [Actions tab]({{ actionsUrl }}), or by clicking **Details** on the pending status below.
+If you want to inspect your running workflow you can do so by heading over to the [Actions tab]({{actionsUrl}}) of this repository.
 
 ---
 
@@ -21,4 +17,4 @@ If the checks don't appear or if the checks are stuck in progress, there's a few
 - Refresh the page, it's possible the workflow ran and the page just hasn't been updated with that change
 - Try making a commit on this branch. Our workflow is triggered with a `push` event, and committing to this branch will result in a new `push`
 - Edit the workflow file on GitHub and ensure there are no red lines indicating a syntax problem
-</details>
+  </details>

responses/01_welcome-activity.md

@@ -1,10 +1,35 @@
-### :keyboard: Activity: Create a pull request to prepare the repository
+## 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.
+
+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.
+
+_In our case, we will use this one **workflow** file for many things, which leads us to break this convention for teaching purposes._
+
+📖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: Create a pull request to prepare the repository for actions
 
 1. Create a new workflow file titled `my-workflow.yml` by using the instructions below, or [this quicklink]({{quicklink}}).
-    - Go to the [Actions tab]({{ actionsUrl }}).
-    - Choose the **Set up a workflow yourself** option, located on the top right hand corner of the screen.
-    - Change the name of the file from `main.yml` to `my-workflow.yml`
-1. Commit the workflow to a new branch.
-1. Create a pull request titled **Initial workflow**.
+   - Go to the [Actions tab]({{ actionsUrl }}).
+   - Choose the **Set up a workflow yourself** option, located on the top right hand corner of the screen.
+   - Change the name of the file from `main.yml` to `my-workflow.yml`.
+1. Commit the workflow to a new branch named `add-initial-workflow`.
+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.
+
+---
 
-I'll respond in the new pull request when I detect it has been created.
+If at any point you're expecting a response and don't see one, refresh the page.