Merge pull request #3 from githubtraining/hectorsector-review

Overall course review

Author: hectorsector

config.yml

@@ -9,9 +9,14 @@ template:
 before:
   - type: updateBranchProtection
   - type: createIssue
-    title: Start Here!
-    body: welcome-issue.md
+    title: Start here!
+    body: 01_welcome-issue.md
+    action_id: welcomeIssue
+  - type: respond
+    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'
       actionsUrl: "%payload.repository.html_url%/actions/new"
 steps:
   - title: Prepare the repository
@@ -28,21 +33,21 @@ steps:
           - left: "%payload.action%"
             operator: ===
             right: edited
-            # AND the pull request title equals 'Initial Workflow'
+            # AND the pull request title equals 'Initial workflow'
       - type: gate
         left: "%payload.pull_request.title%"
         operator: ===
-        right: Initial Workflow
+        right: Initial workflow
 
         # if those statments FAIL... do this
         else:
           - type: respond
             with: e-rename-pr.md
             data:
-              title: Initial Workflow
+              title: Initial workflow
           # if those gates === true Then do this stuff
       - type: closeIssue
-        issue: Start Here!
+        issue: Start here!
       - type: respond
         with: 01_explain-workflow.md
         data:
@@ -63,15 +68,15 @@ steps:
         right: "GitHub Actions"
       - type: respond
         with: 02_workflow-results.md
-        issue: Initial Workflow
+        issue: Initial workflow
         data:
           actionsUrl: "%payload.repository.html_url%/actions"
       - type: getPullRequest
-        pullRequest: Initial Workflow
+        pullRequest: Initial workflow
         action_id: iwPr
       - type: respond
         with: 02_modify-workflow.md
-        issue: Initial Workflow
+        issue: Initial workflow
         data:
           workflowFile: "%payload.repository.html_url%/edit/%actions.iwPr.data.head.ref%/.github/workflows/my-workflow.yml"
 
@@ -81,7 +86,7 @@ steps:
     link: "{{ repoUrl }}/pull/2"
     actions:
       - type: getPullRequest
-        pullRequest: Initial Workflow
+        pullRequest: Initial workflow
         action_id: workflowPr
       - type: respond
         with: 03_reference-actions.md
@@ -101,7 +106,7 @@ steps:
         body: 04_on-to-actions.md
         data:
           issueUrl: "%actions.devEnv.data.html_url%"
-        pullRequest: Initial Workflow
+        pullRequest: Initial workflow
       - type: mergePullRequest
 
   - title: Creating the Action metadata
@@ -211,7 +216,7 @@ steps:
           - left: "%payload.action%"
             operator: ===
             right: edited
-            # AND the pull request title equals 'Initial Workflow'
+            # AND the pull request title equals 'Initial workflow'
       - type: gate
         left: "%payload.pull_request.title%"
         operator: ===
@@ -312,7 +317,7 @@ steps:
           - left: "%payload.action%"
             operator: ===
             right: edited
-            # AND the pull request title equals 'Initial Workflow'
+            # AND the pull request title equals 'Initial workflow'
       - type: gate
         left: "%payload.pull_request.title%"
         operator: ===

responses/01_explain-environment.md

@@ -1,6 +1,6 @@
 ## Anatomy of GitHub Actions
 
-GitHub Actions is a unique world that lives alongside your repository.  It is one made up of many moving parts and having a general understanding of these parts will help us understand the behavior we are going to program into our Action.
+GitHub Actions is a unique world that lives alongside your repository.  It is one made up of many moving parts and having a general understanding of these parts will help us understand the behavior we are going to program into our action.
 
 From 30,000 feet GitHub Actions is made up of the following components, with each component having its own complexities:
 
@@ -24,7 +24,7 @@ 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.
-4.  A job is series of steps, which can be Actions or commands
+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.
 
 

responses/01_explain-syntax.md

@@ -37,7 +37,7 @@ Let's take a second to talk about each of the pieces that we see here:
   - 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

responses/01_welcome-activity.md

@@ -0,0 +1,10 @@
+### :keyboard: Activity: Create a pull request to prepare the repository
+
+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**.
+
+I'll respond in the new pull request when I detect it has been created.

responses/welcome-issue.md renamed to responses/01_welcome-issue.md

@@ -1,76 +1,62 @@
 # Hi there 👋!
 
-Hello @{{user.login}}, I'm so excited to teach you how to create your own Actions 😄
+Hello @{{user.login}}, I'm so excited to teach you how to create your own GitHub Actions 😄
 
 ### Prerequisites
 
-We will be using `Node.js` to build our Action and GitHub to consume our Action.  This presents us with a hybrid environment that you may not be used to if you've taken other Learning Lab courses.
+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**
+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:
+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.
 
 ### Getting started
 
-In this repository we will be diving into the world of GitHub Actions writing!  I will guide you through the process of writing a custom GitHub Action using the **JavaScript** programming language.
+In this repository we will be diving into the world of writing GitHub Actions!  I will guide you through the process of writing a custom GitHub Action using the **JavaScript** programming language.
 
-You may be asking yourself, "what are Actions and is **JavaScript** the only language used to create GitHub Actions?"
+You may be asking yourself, "what are actions and is JavaScript the only language used to create GitHub Actions?"
 
 Currently, there are **two** supported ways to create your own GitHub Actions:
 
-- [Docker Container Actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/about-actions#docker-container-actions) 
-- [JavaScript Actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/about-actions#javascript-actions) 
+- [Docker container actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/about-actions#docker-container-actions) 
+- [JavaScript actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/about-actions#javascript-actions) 
 
-As you can see we aren't necessarily limited to **JavaScript** even though it is the focal point for this course.
+As you can see we aren't necessarily limited to JavaScript even though it is the focal point for this course.
 
 
-### Creating vs Consuming Actions
+### Creating vs consuming actions
 
-Although we are going to focus on creating and consuming a custom Action, in this course we will also be consuming some Actions that have been made public to us.  Because your workflows will most likely do the same, I found it important to show you where to look for Actions that already exist.
+Although we are going to focus on creating and consuming a custom action, in this course we will also be consuming some actions that have been made public to us.  Because your workflows will most likely do the same, I found it important to show you where to look for actions that already exist.
 
 After all, for each time we need to reinvent the wheel for our specific use-case there are a handful of times when we are better off using a wheel that's already made!
 
-- The [GitHub Actions Marketplace](https://github.com/marketplace?type=actions) is the primary place to find open-source Actions that the community has written and released.  Your Action, should you choose to release it, could also reside here one day, ready to be consumed by the world!
-- The [GitHub Actions Repository](https://github.com/actions) is where you can find Actions that are written by GitHub.  We will leverage an Action named "[checkout](https://github.com/actions/checkout)" from this repository as we go through this course.  I'll explain more about what it does when we use it!
-- Your repositories may also contain **private Actions** and they will most likely be located in the `.github/actions` directory in the root of your repository.  **This is the convention we will be using as we learn how to create our own Action.**
+- The [GitHub Actions Marketplace](https://github.com/marketplace?type=actions) is the primary place to find open-source actions that the community has written and released.  Your action, should you choose to release it, could also reside here one day, ready to be consumed by the world!
+- The [GitHub Actions Repository](https://github.com/actions) is where you can find actions that are written by GitHub.  We will leverage an action named `[checkout](https://github.com/actions/checkout)` from this repository as we go through this course.  I'll explain more about what it does when we use it!
+- Your repositories may also contain **private actions** and they will most likely be located in the `.github/actions` directory in the root of your repository.  **This is the convention we will be using as we learn how to create our own action.**
 
-### Using Actions and Learning Lab
+### Using actions and Learning Lab
 
-In other courses, you may have noticed that some behaviors take me longer to respond to than others. In this course, many of the behaviors will be related to our Actions workflow. Those workflows sometimes take longer to complete, up to several minutes. Don't be concerned if I take a few minutes to respond, or if I respond too quickly. Sometimes, I'll let you know what the workflow will say before it finishes! Please wait for the workflows to finish before moving on to your next step.
+In other courses, you may have noticed that some behaviors take me longer to respond to than others. In this course, many of the behaviors we'll see demonstrated will be related to our GitHub Actions workflow. Those workflows sometimes take longer to complete, up to several minutes. Don't be concerned if I take a few minutes to respond, or if I respond too quickly. Sometimes, I'll let you know what the workflow will say before it finishes! Please wait for the workflows to finish before moving on to your next step.
 
 If you aren't already familiar, it may be a good idea to go through the [Introduction to GitHub Learning Lab](https://lab.github.com/githubtraining/introduction-to-github).
 
 ## Preparing your repository
 
-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.
+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.
 
 These individual steps take one of two forms.  
 - Run a raw command such as `echo` or `npm install`
-- Use an Action such as the one we will be building
+- Use an action such as the one we will be building
 
 📖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
-
-1. Go to the [Actions tab]({{ actionsUrl }}).
-2. Choose the **Set up a workflow yourself** option, located on the top right hand corner of the screen.
-3. Change the name of the file from `main.yml` to `my-workflow.yml`
-4. Commit the workflow to a new branch.
-5. Create a pull request titled **Initial Workflow**.
-
-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.
-
-
-
-
+If at any point you're expecting a response and don't see one, refresh the page.

responses/02_explain-steps.md

@@ -1,31 +1,31 @@
 ## Digging into a step
 
-As I mentioned earlier, a step is a task that is either an Action or a Command.  This can be slightly confusing, so I want to take a little time to ensure I explain it to you before moving on.
+As I mentioned earlier, a step is a task that is either an action or a command.  This can be slightly confusing, so I want to take a little time to ensure I explain it to you before moving on.
 
 #### Actions
 
 Actions are powerful.  They are small programs written in either JavaScript or running inside of Docker containers, that add some functionality to your repository.
 
-The things you can do with Actions are limited only by your imagination.  Want to send a tweet every time you tag a release?  What about ordering 🍕just by creating an issue?
+The things you can do with actions are limited only by your imagination.  Want to send a tweet every time you tag a release?  What about ordering 🍕just by creating an issue?
 
-Let's not forget the more practical usage of Actions, testing the source code of a repository or letting your team know that you are out of office 🏝 when they @ mention your name in issues or pull requests.
+Let's not forget the more practical usage of actions, testing the source code of a repository or letting your team know that you are out of office 🏝 when they @ mention your name in issues or pull requests.
 
 You can define an action's inputs, outputs, and environment variables to create reusable building blocks for your workflow.
 
-Actions are portable.  You are free to publish your Actions to the [Actions Marketplace](https://github.com/marketplace?type=actions) where others can use your creation in their workflows!  You can also share actions without publishing them to the marketplace by referencing the repository that contains the Actions code!
+Actions are portable.  You are free to publish your actions to the [Actions Marketplace](https://github.com/marketplace?type=actions) where others can use your creation in their workflows!  You can also share actions without publishing them to the marketplace by referencing the repository that contains the actions code!
 
 Actions can even run commands 😏
 
 📖Learn more [About Actions](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/about-actions)
 
 #### Commands
 
-Commands are useful in the own respect, but are much more limited than Actions.  
+Commands are useful in the own respect, but are much more limited than actions.  
 
 Think about the tasks you might do from the command line of your local machine.  Maybe you run `npm install` to install all of the dependencies for your project before running your unit tests.  Maybe you run `docker build` to execute a Dockerfile.
 
 You can accomplish the same set of tasks inside of a workflow but using `run` as a step in your job.  
 
 Commands are not easily shareable.  There is no central location where you can consume the popular commands used in workflows.  You do not have access to fine tuning the inputs, outputs or environment variables.
 
-This does not mean commands offer no value in a workflow, but you should use them wisely and if you find yourself reusing the same commands repeatedly, consider turning them into Actions.
+This does not mean commands offer no value in a workflow, but you should use them wisely and if you find yourself reusing the same commands repeatedly, consider turning them into actions.

responses/02_modify-workflow.md

@@ -1,6 +1,6 @@
 ## Edit the current workflow
 
-Currently `my-workflow.yml` is not set up correctly for our use-case.  It worked great for allowing us to take a high-level look at workflows, but if we want to use our custom Actions there are some changes that we have to make to it.
+Currently `my-workflow.yml` is not set up correctly for our use-case.  It worked great for allowing us to take a high-level look at workflows, but if we want to use our custom actions there are some changes that we have to make to it.
 
 ### :keyboard: Activity: Modify my-workflow.yml to remove boilerplate steps
 

responses/02_workflow-results.md

@@ -18,7 +18,7 @@ The right-hand panel shows real-time logging of the steps executed by the `build
 
 GitHub Actions will **always** add the `Set up job` and `Complete job` steps to each job in a workflow.  These steps are what configure the [virtual environment](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners) before running your steps and shut it down properly before moving onto the next job in your workflow.
 
-If you recall, we had 1 step that used an Action and 2 steps that ran commands, can you identify which step used the Action?
+If you recall, we had 1 step that used an action and 2 steps that ran commands, can you identify which step used the action?
 
 If you said `actions/checkout@v1` you'd be correct 😄!