Skip to content

Commit 99482a8

Browse files
authored
Add feedback text (#17)
1 parent edf6f9e commit 99482a8

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

README.md

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,20 @@ Write your own GitHub JavaScript Action and automate customized tasks unique to
3939

4040
</details>
4141

42-
4342
<!--
4443
<<< Author notes: Step 1 >>>
4544
Choose 3-5 steps for your course.
4645
The first step is always the hardest, so pick something easy!
4746
Link to docs.github.com for further explanations.
4847
Encourage users to open new tabs for steps!
49-
TBD-step-1-notes.
5048
-->
5149

50+
<details id=1>
51+
52+
<summary><h2> Step 1: Initialize a new JavaScript project</h2></summary>
53+
54+
_Welcome to the course :tada:_
55+
5256
### Configuring a workflow
5357

5458
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.
@@ -61,10 +65,6 @@ _In our case, we will use this one **workflow** file for many things, which lead
6165

6266
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)
6367

64-
<details id=1>
65-
66-
<summary><h2> Step 1: Initialize a new JavaScript project</h2></summary>
67-
6868
## On to your development environment
6969

7070
Our JavaScript actions are going to leverage the [GitHub ToolKit](https://github.com/actions/toolkit) for developing GitHub Actions.
@@ -83,7 +83,7 @@ Most of your work going forward will take place away from your Skills repository
8383
2. [ ] [Visual Studio Code](https://code.visualstudio.com/) or your editor of choice
8484
3. [ ] [Git](https://git-scm.com/)
8585

86-
### Activity 1: Initialize a new JavaScript project
86+
### :keyboard: Activity 1: Initialize a new JavaScript project
8787

8888
Once you have the necessary tools installed locally, follow these steps to begin creating your first action.
8989

@@ -132,11 +132,13 @@ Once you have the necessary tools installed locally, follow these steps to begin
132132
<details id=2>
133133
<summary><h2> Step 2: Configure Your Action</h2></summary>
134134

135+
_Let's keep going! :bike:_
136+
135137
### Excellent!
136138
137139
Now that we have the custom action pre-requisites, let us create **joke-action** action.
138140
139-
### Activity 1: Configure Your Action
141+
### :keyboard: Activity 1: Configure Your Action
140142
141143
All of the following steps take place inside of the `.github/actions/joke-action` directory.
142144
@@ -168,6 +170,8 @@ We will start with using the parameters that are **required** and later implemen
168170
<details id=3>
169171
<summary><h2> Step 3: Create the metadata file</h2></summary>
170172
173+
_Nice working configuring your action :smile:_
174+
171175
## Action metadata
172176
173177
Every GitHub Action that we write needs to be accompanied by a metadata file. This file has a few rules to it, as are indicated below:
@@ -191,7 +195,7 @@ This file defines the following information about your action:
191195
192196
Read more about [Action metadata](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions)
193197
194-
### Activity 1: Create the metadata file
198+
### :keyboard: Activity 1: Create the metadata file
195199
196200
All of the following steps take place inside of the `.github/actions/joke-action` directory.
197201
@@ -226,6 +230,8 @@ Our action does not require much metadata for it to run correctly. We will not b
226230
<details id=4>
227231
<summary><h2> Step 4: Create the JavaScript files for your action</h2></summary>
228232
233+
_Good job adding the metadata file! :dancer:_
234+
229235
## Files
230236
231237
As you probably know, in JavaScript and other programming languages it is common to break your code into modules so that it is easier to read and maintain going forward. Since JavaScript actions are just programs written in JavaScript that run based on a specific trigger we are able to make our action code modular as well.
@@ -333,7 +339,7 @@ _Don't forget to call the `run()` function._
333339
334340
</details>
335341
336-
### Activity 1: Creating the JavaScript files for your new action.
342+
### :keyboard: Activity 1: Creating the JavaScript files for your new action.
337343
338344
1. Create and add the following contents to the `.github/actions/joke-action/joke.js` file:
339345
@@ -389,11 +395,11 @@ _Don't forget to call the `run()` function._
389395
<details id=5>
390396
<summary><h2> Step 5: Add your action to the workflow file</h2></summary>
391397
392-
### Great job!
398+
_Great job! :tada:_
393399
394400
All of the following steps will add the action to the workflow file that’s already in the repo [`my-workflow.yml` file](/.github/workflows/my-workflow.yml)
395401
396-
### Activity 1: Edit the custom action at the bottom of the workflow file.
402+
### :keyboard: Activity 1: Edit the custom action at the bottom of the workflow file.
397403
398404
```yaml
399405
- name: ha-ha
@@ -429,7 +435,8 @@ You can make these changes in your repository by opening [`my-workflow.yml`](/.g
429435
430436
<summary><h2> Step 6: Trigger the joke action</h2></summary>
431437
432-
### Great job!
438+
_Great job! :heart:_
439+
433440
Everything is all set up and now we are ready to start laughing. You will find you have some joke related labels available to you in this repository. You don't have to use them, any label will trigger our workflow, but the easiest way to follow along would be to use suggested labels.
434441
435442
### Trigger a joke
@@ -444,6 +451,8 @@ Everything is all set up and now we are ready to start laughing. You will find y
444451
<details id=X>
445452
<summary><h2>Finish</h2></summary>
446453
454+
<img src=https://octodex.github.com/images/poptocat_v2.png alt=celebrate width=300 align=right>
455+
447456
### Congratulations, you've completed this course!
448457
449458
In this course, you've learned a lot about developing custom actions using JavaScript and Actions Toolkit.

0 commit comments

Comments
 (0)