Merge pull request #6 from githubtraining/error-handling

Error handling

Author: hectorsector

config.yml

@@ -1,6 +1,6 @@
 [GitHub Actions](https://github.com/features/actions) is a powerful platform that empowers your team to go from code to cloud all from the comfort of your own repositories.
 
-Over the duration of this course, approximately 1 hour, you will learn the skills needed to begin using and customizing GitHub Actions to fit your unique workflow scenarios.
+Over the duration of this course you will learn the skills needed to begin using and customizing GitHub Actions to fit your unique workflow scenarios.
 
 ## What you'll learn
 

course-details.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 a workflow file similar to what we just committed to this repository.
 
 ```yaml
 name: CI
@@ -52,3 +52,5 @@ Let's take a second to talk about each of the pieces that we see here:
 
 📖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)
+
+*if you don't see a response from me below this, try making a new commit to this branch.  Your workflow may have finished before I was ready to listen*

responses/01_explain-syntax.md

@@ -12,12 +12,12 @@ _In our case, we will use this one **workflow** file for many things, which lead
 
 ### :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}}).
+1. Create a new workflow file titled `my-workflow.yml` inside of the folders `.github/workflows/` 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 named `add-initial-workflow`.
-1. Create a pull request titled **Create my-workflow.yml**.
+   - Change the name of the file to `.github/workflows/my-workflow.yml`.
+1. Commit the workflow to a new branch, you can name it `add-initial-workflow`.
+1. Create a pull request titled **Create a workflow**.
 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._

responses/01_welcome-activity.md

@@ -4,29 +4,23 @@ Currently `my-workflow.yml` is not set up correctly for our use-case. It worked
 
 ### :keyboard: Activity: Modify my-workflow.yml to remove boilerplate steps
 
-1. [Edit]({{workflowFile}}) the `my-workflow.yml`.
-2. Change the `name:` property located of `my-workflow.yml` to `JS Actions`
-3. Rename the job from `build` to `action`
-4. Remove the two steps that run commands, but leave the step that runs the checkout action.
-5. Commit these file changes to this branch
+1. [Edit]({{workflowFile}}) the `my-workflow.yml` to have the following contents:
+    ```yaml
+    name: JS Actions
 
-I'll respond in this pull request once you make these changes.
-
----
+    on: [push]
 
-<details><summary>The complete workflow can be viewed by clicking here</summary>
+    jobs:
+      action:
+        runs-on: ubuntu-latest
 
-```yaml
-name: JS Actions
+        steps:
+          - uses: actions/checkout@v1
+    ```
+2. Commit these file changes to this branch
 
-on: [push]
+---
 
-jobs:
-  action:
-    runs-on: ubuntu-latest
+I'll respond in this pull request once you make these changes.
 
-    steps:
-      - uses: actions/checkout@v1
-```
 
-</details>

responses/02_modify-workflow.md

@@ -23,29 +23,25 @@ If you'd like to see more examples of workflows and actions then check out these
 
 ### :keyboard: Activity: Modify my-workflow.yml to run our custom action
 
-1. [Edit]({{workflowFile}}) the `my-workflow.yml`.
-1. Add a new `step:` and `name:` it `hello-action`
-1. Set the value of `uses:` to `./.github/actions/hello-world`
-1. Commit these file changes to this branch
-
----
+1. [Edit]({{workflowFile}}) the `my-workflow.yml` to contain the following:
+    ```yaml
+    name: JS Actions
 
-<details><summary>The complete workflow can be viewed by clicking here</summary>
+    on: [push]
 
-```yaml
-name: JS Actions
+    jobs:
+      action:
 
-on: [push]
+        runs-on: ubuntu-latest
 
-jobs:
-  action:
+        steps:
+        - uses: actions/checkout@v1
 
-    runs-on: ubuntu-latest
+        - name: hello-action
+          uses: ./.github/actions/hello-world
+    ```
+1. Commit these file changes to this branch
 
-    steps:
-    - uses: actions/checkout@v1
+---
 
-    - name: hello-action
-      uses: ./.github/actions/hello-world
-```
-</details>
+I'll respond when I notice you've made these changes

responses/03_reference-actions.md

@@ -8,7 +8,8 @@ Now that we know what action metadata is, let's create the metadata for our curr
 
 We will start with using the parameters that are **required** and later implement some optional parameters as our action evolves.
 
-1. Create and add the following contents to the `.github/actions/hello-world/action.yml` file:
+1. Create a new file in: `.github/actions/hello-world/action.yml`
+1. Add the following contents to the `.github/actions/hello-world/action.yml` file:
    ```yaml
    name: "my hello action"
 
@@ -19,11 +20,12 @@ We will start with using the parameters that are **required** and later implemen
      main: "main.js"
    ```
 2. Save the `action.yml` file
-3. Commit the changes:
-   `git add action.yml`
-   `git commit -m 'create action.yml'`
-4. Push them to the `hello-world` branch:
-   `git push`
+3. Commit the changes and push them to the `hello-world` branch:
+   ```shell
+   git add action.yml
+   git commit -m 'create action.yml'
+   git push
+   ```
 
  ---
 

responses/05_create-metadata.md

@@ -21,11 +21,12 @@ The first iteration of our action will follow the traditional path of logging "H
    ```
 
 1. Save the `main.js` file
-1. Commit the changes:
-   `git add main.js`
-   `git commit -m 'create main.js'`
-1. Push them to the `hello-world` branch:
-   `git push`
+1. Commit the changes and push them to the `hello-world` branch:
+   ```shell
+   git add main.js
+   git commit -m 'create main.js'
+   git push
+   ```
 
 ---
 

responses/06_main-js.md

@@ -76,12 +76,24 @@ That was a lot of information that you just learned. @{{user.login}} it is time
       </details>
 
 2. Save the changes to each file
-3. Commit the changes to this branch
-   `git add main.js action.yml workflow.yml`
-   `git commit -m 'allow input in all action files'`
-4. Push the changes from your local machine to this repository.
-   `git push`
+3. Commit the changes to this branch and push them to GitHub:
+
+   ```shell
+   git add main.js action.yml workflow.yml
+   git commit -m 'allow input in all action files'
+   git push
+   ```
 
 ---
 
-I'll respond here when you finish this step.
+I'll respond here when GitHub Actions reports it's finished.
+
+<details><summary>Is your workflow failing?</summary>
+
+If you workflow is failing, please double check your:
+- JavaScript source code
+- action metadata
+- workflow file
+
+Look for linter errors or any errors reported on the Actions tab. I will respond when I receive another workflow run is completed.
+</details>

responses/07_update-files.md

@@ -5,35 +5,32 @@ Before we continue we are going to need to do a few things. First and foremost o
 ### :keyboard: Activity: Setting up the next action
 
 1. [Edit]({{workflowFile}}) your workflow file by commenting out every single line. _(To comment in `.yml`, add a `#` symbol to the beginning of every line)_.
-2. Commit the changes to a new branch and name it `action-two`.
-3. Create a pull request named **External APIs**
-4. Supply the pull request with body content. Remember, this area can be used a notes later.
-5. Click `Create pull request`.
-
-You will still see the workflow trying to execute with every push if you look at the [Actions tab]({{actionsUrl}}), however it will seem as though it fails. This is because there is a workflow file in the `.github/workflows` directory. The failure isn't actually a failure either, if you expand it you will see that there is simple no triggers for that given workflow and therefore it doesn't run. I have placed a screenshot below so you can become familiar with what this error looks like without the need to go to your [Actions tab]({{actionsUrl}}).
+    ```yaml
+    # name: JS Actions
 
-![No trigger screenshot](https://i.imgur.com/rARtXc1.png)
-Like our first action, I'll respond in the new pull request when I detect it has been opened.
+    # on: [push]
 
----
+    # jobs:
+    #   action:
 
-<details><summary>The complete workflow can be viewed by clicking here</summary>
+    #     runs-on: ubuntu-latest
 
-```yaml
-# name: JS Actions
+    #     steps:
+    #     - uses: actions/checkout@v1
 
-# on: [push]
+    #     - name: hello-action
+    #       uses: ./.github/actions/hello-world
+    ```
+2. Commit the changes to a new branch, you can name it `action-two`.
+3. Create a pull request named **External APIs**
+4. Supply the pull request with body content. Remember, this area can be used a notes later.
+5. Click `Create pull request`.
 
-# jobs:
-#   action:
+You will still see the workflow trying to execute with every push if you look at the [Actions tab]({{actionsUrl}}), however it will seem as though it fails. This is because there is a workflow file in the `.github/workflows` directory. The failure isn't actually a failure either, if you expand it you will see that there is simple no triggers for that given workflow and therefore it doesn't run. I have placed a screenshot below so you can become familiar with what this error looks like without the need to go to your [Actions tab]({{actionsUrl}}).
 
-#     runs-on: ubuntu-latest
+![No trigger screenshot](https://i.imgur.com/rARtXc1.png)
 
-#     steps:
-#     - uses: actions/checkout@v1
 
-#     - name: hello-action
-#       uses: ./.github/actions/hello-world
-```
+---
 
-</details>
+Like our first action, I'll respond in the new pull request when I detect it has been opened.