Merge pull request #5 from githubtraining/activity-titles

Match step titles to activities

Author: hectorsector

config.yml

@@ -5,6 +5,12 @@ description: >-
 template:
   repo: 'write-docker-actions-template'
   name: 'write-docker-actions'
+tags:
+  - Docker
+  - Containers
+  - Workflows
+  - Application programming interface (API)
+  - Publishing GitHub Actions
 
 # Repo artifacts
 # 1. (Issue) Start here!
@@ -82,8 +88,8 @@ steps:
         data:
           workflowFile: '%payload.repository.html_url%/edit/%payload.pull_request.head.ref%/.github/workflows/my-workflow.yml'
 
-  - title: Add an Action reference
-    description: Add an Action reference to the workflow file
+  - title: Edit the current workflow
+    description: Remove boilerplate steps from `my-workflow.yml`
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/2'
     actions:
@@ -104,8 +110,8 @@ steps:
         data:
           workflowFile: '%payload.repository.html_url%/edit/%actions.workflowPr.data.head.ref%/.github/workflows/my-workflow.yml'
 
-  - title: Creating the Action metadata
-    description: Create an action.yml file and add necessary metatdata for our Action
+  - title: Add an action reference to the workflow
+    description: Reference our custom action from `my-workflow.yml`
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/2'
     actions:
@@ -137,8 +143,8 @@ steps:
         pullRequest: Create my first workflow
       - type: mergePullRequest
 
-  - title: Creating the action logic
-    description: Adding source code to the action
+  - title: Create the action metadata
+    description: Create an `action.yml` file and add necessary metadata
     event: 
       - pull_request.opened
       - pull_request.edited
@@ -172,8 +178,8 @@ steps:
       - type: closeIssue
         issue: Your first Docker based action
 
-  - title: Create the action Dockerfile
-    description: Creat a Dockerfile containing the actions source code
+  - title: Write the Hello World source code
+    description: Create `main.go` containing the Hello World source code
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/4'
     actions:
@@ -221,8 +227,8 @@ steps:
           actionsUrl: '%payload.repository.html_url%/actions'
           quicklink: '%payload.repository.html_url%/new/%payload.pull_request.head.ref%?filename=.github/actions/hello-world/Dockerfile'
 
-  - title: Adding input parameters to metadata
-    description: extend your action to accept input parameters
+  - title: Create the action's `Dockerfile`
+    description: Create a `Dockerfile` containing the Docker instructions
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/4'
     actions:
@@ -276,8 +282,8 @@ steps:
         data:
           quicklink: '%payload.repository.html_url%/edit/%payload.pull_request.head.ref%/.github/actions/hello-world/action.yml'
 
-  - title: Adding input parameters to source code files
-    description: extend your action to accept input parameters
+  - title: Add input parameters to Hello World's metadata
+    description: Update `action.yml` to accept input parameters for Hello World
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/4'
     actions:
@@ -295,8 +301,8 @@ steps:
         data:
           quicklink: '%payload.repository.html_url%/edit/%payload.pull_request.head.ref%/.github/actions/hello-world/main.go'
 
-  - title: Using input parameters in the workflow
-    description: Assign values to the newly created input parameters
+  - title: Use input parameters in the source code
+    description: Extend Hello World's source code to accept the input parameters
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/4'
     actions:
@@ -314,8 +320,8 @@ steps:
         data:
           quicklink: '%payload.repository.html_url%/edit/%payload.pull_request.head.ref%/.github/workflows/my-workflow.yml'
 
-  - title: Exploring your input parameters
-    description: view the results of adding input parameter
+  - title: Use input parameters in the workflow
+    description: Assign values to the newly created input parameters in `my-workflow.yml`
     event: pull_request.synchronize #ideally would like workflow complete to trigger this
     link: '{{ repoUrl }}/pull/4'
     actions:
@@ -336,8 +342,8 @@ steps:
       - type: respond
         with: 08_experiment.md
 
-  - title: Integrating actions with external APIs
-    description: Write a new action that calls an external API
+  - title: Explore your input parameters
+    description: View the results of changing input parameters
     event: pull_request.closed
     link: '{{ repoUrl }}/pull/4'
     actions:
@@ -369,7 +375,7 @@ steps:
         data:
           issueUrl: '%actions.catFact.data.html_url%'
 
-  - title: Create your new Action metadata
+  - title: Setting up the next action
     description: Comment out the lines in the workflow to prevent unwanted runs
     event: 
       - pull_request.opened
@@ -401,8 +407,8 @@ steps:
         data:
           quicklink: '%payload.repository.html_url%/new/%payload.pull_request.head.ref%?filename=.github/actions/cat-facts/action.yml'
 
-  - title: Create your action's source code files
-    description: Add main.py to your Action
+  - title: Add metadata to the cat-fats action
+    description: Create the cat-facts metadata file
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/6'
     actions:
@@ -449,8 +455,8 @@ steps:
         data:
           quicklink: '%payload.repository.html_url%/new/%payload.pull_request.head.ref%?filename=.github/actions/cat-facts/src/main.py'
 
-  - title: Add Python dependencies
-    description: Add the requirements.txt file
+  - title: Fetch a cat fact
+    description: Create the Python source code for the cat-fats action
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/6'
     actions:
@@ -497,8 +503,8 @@ steps:
         data:
           quicklink: '%payload.repository.html_url%/new/%payload.pull_request.head.ref%?filename=.github/actions/cat-facts/requirements.txt'
 
-  - title: Create the Dockerfile for the action
-    description: Add the Dockerfile to the action
+  - title: Add Python dependencies
+    description:  Create `requirements.txt` with your Python dependencies
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/6'
     actions:
@@ -545,8 +551,8 @@ steps:
         data:
           quicklink: '%payload.repository.html_url%/new/%payload.pull_request.head.ref%?filename=.github/actions/cat-facts/Dockerfile'
 
-  - title: Use the cat fact action in a workflow
-    description: Edit the workflow file to now use the newly created cat fact action
+  - title: Add the cat-fact `Dockerfile`
+    description: Create `Dockerfile` for the cat-fat action
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/6'
     actions:
@@ -597,8 +603,8 @@ steps:
           workflowFile: '%payload.repository.html_url%/edit/%actions.apiPr.data.head.ref%/.github/workflows/my-workflow.yml'
           actionsUrl: '%payload.repository.html_url%/actions'
 
-  - title: Having actions teach us about cats
-    description: Trigger your workflow to get cat facts
+  - title: Use the cat-fat action
+    description: Restore the workflow file
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/6'
     actions:
@@ -618,8 +624,8 @@ steps:
         data:
           actionsUrl: '%payload.repository.html_url%/actions'
 
-  - title: Configure the workflow for a third Action
-    description: Edit the workflow to accomodate the third action
+  - title: Get ready to purr
+    description: Trigger a cat fact
     event: pull_request.closed
     link: '{{ repoUrl }}/pull/6'
     actions:
@@ -649,8 +655,8 @@ steps:
         data:
           issueUrl: '%actions.outputIssue.data.html_url%'
 
-  - title: Write the final Action
-    description: Create an Action that consumes output from another Action and uses the JavaScript actions toolkit
+  - title: Reference the issue-maker action
+    description: Reference issue-maker in the `my-workflow.yml`
     event: 
       - pull_request.opened
       - pull_request.edited
@@ -681,8 +687,8 @@ steps:
         data:
           quicklink: '%payload.repository.html_url%/new/%payload.pull_request.head.ref%?filename=.github/actions/issue-maker/package.json'
 
-  - title: Add third Actions metadata
-    description: Create the metadata for the third Action
+  - title: Add dependencies for issue-maker action
+    description: Add `package.json` to issue-maker
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/8'
     actions:
@@ -729,8 +735,8 @@ steps:
         data:
           quicklink: '%payload.repository.html_url%/new/%payload.pull_request.head.ref%?filename=.github/actions/issue-maker/action.yml'
 
-  - title: Add third Actions JavaScript files
-    description: Create the JavaScript files for the third Action
+  - title: Create the issue-maker's action metadata
+    description: Add `action.yml` for issue-maker
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/8'
     actions:
@@ -777,8 +783,8 @@ steps:
         data:
           quicklink: '%payload.repository.html_url%/new/%payload.pull_request.head.ref%?filename=.github/actions/issue-maker/src/index.js'
 
-  - title: Create the final actions Dockerfile
-    description: Add a pull request label to trigger the workflow
+  - title: Add the issue-maker action's source code
+    description: Add `src/index.js` for issue-maker
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/8'
     actions:
@@ -825,8 +831,8 @@ steps:
         data:
           quicklink: '%payload.repository.html_url%/new/%payload.pull_request.head.ref%?filename=.github/actions/issue-maker/Dockerfile'
 
-  - title: Trigger the third Action
-    description: Add a pull request label to trigger the workflow
+  - title: Add the issue-maker action's `Dockerfile`
+    description: Create `Dockerfile` for issue-maker
     event: pull_request.synchronize
     link: '{{ repoUrl }}/pull/8'
     actions:

course-details.md

@@ -1,13 +1,16 @@
 [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.
+This course will teach you the skills needed to begin using and customizing Docker container based actions to fit your unique workflow scenarios.
 
 ## What you'll learn
 
-In this course you will learn how to:
+After completing this course, you will be able to:
 
 - Consume actions within a workflow file
-- Create custom Docker based actions
+- Create custom Docker container based actions
+- Create actions in your programming language of choice
+- Leverage an external API within an action
+- Set and use input parameters for actions
 - Publish your newly created action to the marketplace
 
 You'll know the answers to questions like:
@@ -18,31 +21,36 @@ You'll know the answers to questions like:
 - What is a `Dockerfile`?
 - What are GitHub Actions capable of?
 - What programming languages can I write GitHub Actions in?
+- How do I publish an action?
+- How do I customize my action's behavior based on inputs?
 
 ## What you'll build
 
+![screenshot of three actions: issue-maker, hello-world, and cat-facts](https://user-images.githubusercontent.com/16547949/77695797-b87f3f00-6f82-11ea-8131-9d362cfc1e4b.png)
+
 In this course you will build three actions that each accomplish different tasks designed to demonstrate the flexibility of creating and consuming Docker Based Actions.
 
-First, you will start with the traditional "Hello World!" program which will teach you where to find the output of a workflow run. You will then modify this "Hello World!" action to accept `input` parameters which allow the action to be more dynamic. This action will be written using the Go programming language.
+1. **Hello, world!** You will start with the traditional "Hello, world!" program which will teach you where to find the output of a workflow run. You will then modify this "Hello World!" action to accept `input` parameters which allow the action to be more dynamic. This action will be written using the Go programming language.
 
-Second, you will write an action that call upon an external API to retrieve a fact about cats and prints it to the workflows output. You will then modify this cat fact action to set the retrieved data as `output` for another action in the workflow to consume. This action will be written using the Python programming language.
+2. **Cat facts** You will write an action that call upon an external API to retrieve a fact about cats and prints it to the workflows output. You will then modify this cat fact action to set the retrieved data as `output` for another action in the workflow to consume. This action will be written using the Python programming language.
 
-Lastly, you will write a third action that will open an issue in your repository making the cat fact available to everyone. You will learn how to use the `output` of previous actions as `input` for current actions in this step. This action will be written using the JavaScript programming language.
+3. **Issue maker** You will open an issue in your repository making the cat fact available to everyone. You will learn how to use the `output` of previous actions as `input` for current actions in this step. This action will be written using the JavaScript programming language.
 
 ## Prerequisites
 
-We will be using the GitHub UI to build and consume our actions. Since this is a course on [Docker](https://docs.docker.com/get-started/) based actions, having a basic understanding of Docker is recommended.
+We recommend you first take the following courses on Learning Lab:
+- [GitHub Actions: Hello World](https://lab.github.com/githubtraining/github-actions:-hello-world)
 
-It is also worth noting that this course is one of many in a GitHub Actions Learning Path. It is recommended that you complete this learning path in order to get the most out of your Learning Lab experience.
+Since this is a course on [Docker](https://docs.docker.com/get-started/) based actions, having a basic understanding of Docker is recommended.
 
 ## Projects used
 
-- [Docker](https://www.docker.com/), a container engine
 - [GitHub Actions Toolkit](https://github.com/actions/toolkit), a multipurpose JavaScript library for writing actions
+- [Docker](https://www.docker.com/), a container engine
 - [Python](https://www.python.org/doc/essays/blurb/), an interpreted, object-oriented, high-level programming language
 - [Go](https://golang.org/), Go is an open source programming language that makes it easy to build simple, reliable, and efficient software
 - [Requests](https://requests.readthedocs.io/en/master/), an elegant and simple HTTP library for Python
 
 ## Audience
 
-This is a great course for intermediate developers who are looking to learn how to create custom actions to benefit their workflows. The focal point of the content isn't on which language to create your actions in, rather how to put the pieces of source code, metadata, `Dockerfile` and workflows together to accomplish your goals.
+Developers, DevOps Engineers, students, teams

responses/01_welcome-activity.md

@@ -1,6 +1,6 @@
-## Configuring a workflow
+## Setup a workflow file
 
-### :keyboard: Activity: Create a pull request to prepare the repository for actions
+### :keyboard: Activity: Create a pull request to add a workflow
 
 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 }}).
@@ -18,8 +18,6 @@ _It is important to place meaningful content into the body of the pull requests
 
 </details>
 
-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.
+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.

responses/02_modify-workflow.md

@@ -2,7 +2,7 @@
 
 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
+### :keyboard: Activity: Remove boilerplate steps from `my-workflow.yml`
 
 1. [Edit]({{workflowFile}}) the `.github/workflows/my-workflow.yml` so that it has the contents below:
 
@@ -23,4 +23,4 @@ Currently `my-workflow.yml` is not set up correctly for our use-case. It worked
 
 ---
 
-I'll respond in this pull request once you make these changes.
+I'll respond when you push changes to this pull request.

responses/03_reference-actions.md

@@ -21,7 +21,9 @@ If you'd like to see more examples of workflows and actions then check out these
 - [GitHub Actions: Continuous Delivery](https://lab.github.com/githubtraining/github-actions:-continuous-delivery)
 - [GitHub Actions: Publish to GitHub Packages](https://lab.github.com/githubtraining/github-actions:-publish-to-github-packages)
 
-### :keyboard: Activity: Modify my-workflow.yml to run our custom action
+## Add an action reference to the workflow
+
+### :keyboard: Activity: Reference our custom action from `my-workflow.yml`
 
 1. [Edit]({{workflowFile}}) the `my-workflow.yml` to have the following contents:
 
@@ -45,4 +47,4 @@ If you'd like to see more examples of workflows and actions then check out these
 
 ---
 
-I'll respond in this pull request once you make these changes.
+I'll respond when you push changes to this pull request.

responses/05_create-metadata.md

@@ -1,8 +1,8 @@
-## Enough talk, lets do this!
+## Create the action metadata
 
 Now that we know what action metadata is, let's create the metadata for our **hello-world** action.
 
-### :keyboard: Activity: Create the metadata file
+### :keyboard: Activity: Create an `action.yml` file and add necessary metadata
 
 💡All of the following steps take place inside of the `.github/actions/hello-world` directory.
 
@@ -24,3 +24,7 @@ We will start with using the parameters that are **required** and later implemen
 1. Commit the changes to a new branch named `hello-world`
 1. Create a pull request titled **Add a Hello World action**.
 1. Supply the pull request body content and click `Create pull request`.
+
+---
+
+I'll respond when you create a new pull request.