Skip to content

Commit 4e197ca

Browse files
authored
Update README.md
1 parent dd2a6e1 commit 4e197ca

File tree

1 file changed

+8
-25
lines changed

1 file changed

+8
-25
lines changed

README.md

Lines changed: 8 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,6 @@ Write your own GitHub JavaScript Action and automate customized tasks unique to
2626
- **What you'll learn**: How to consume actions within a workflow file, create custom JavaScript based actions and publish your newly created action to the marketplace.
2727
- **Prerequisites**: Before you start, you should be familiar with GitHub, GitHub Actions, and Continuous Integration with GitHub Actions.
2828
- **How long**: This course is 6 steps long and takes about 1 to 2 hours to be completed.
29-
30-
## Projects used
31-
32-
This makes use of the following open source projects. Consider exploring these repos and maybe even making contributions!
33-
34-
- [GitHub Actions Toolkit](https://github.com/actions/toolkit), a multipurpose JavaScript library for writing actions
3529

3630
## How to start this course
3731

@@ -55,17 +49,6 @@ This makes use of the following open source projects. Consider exploring these r
5549
Encourage users to open new tabs for steps!
5650
TBD-step-1-notes.
5751
-->
58-
### Welcome to this Skills course about Actions where you will build the following:
59-
60-
- ![screenshot of a pull request in the course with instructions on how to fetch a joke from the API, a second screenshot of a workflow running and outputting the joke: "Guy told me today he did not know what cloning is. I told him, that makes 2 of us."](https://user-images.githubusercontent.com/16547949/76105870-cce3a380-5fa3-11ea-8882-7138319b4100.png)
61-
62-
- In this course you will build three actions that each accomplish different tasks designed to demonstrate the flexibility of creating and consuming JavaScript Based Actions.
63-
64-
- 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.
65-
66-
- 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.
67-
68-
- 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.
6952

7053
### Configuring a workflow
7154

@@ -79,9 +62,9 @@ _In our case, we will use this one **workflow** file for many things, which lead
7962

8063
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)
8164

82-
<details id=1 open>
65+
<details id=1 close>
8366

84-
<summary><strong> Step 1: Initialize a new JavaScript project</strong></summary>
67+
<summary><h2> Step 1: Initialize a new JavaScript project</h2></summary>
8568

8669
## On to your development environment
8770

@@ -148,7 +131,7 @@ Once you have the necessary tools installed locally, follow these steps to begin
148131
</details>
149132

150133
<details id=2>
151-
<summary><strong> Step 2: Configure Your Action</strong></summary>
134+
<summary><h2> Step 2: Configure Your Action</h2></summary>
152135

153136
### Excellent!
154137

@@ -183,7 +166,7 @@ We will start with using the parameters that are **required** and later implemen
183166
</details>
184167

185168
<details id=3>
186-
<summary><strong> Step 3: Create the metadata file</strong></summary>
169+
<summary><h2> Step 3: Create the metadata file</h2></summary>
187170

188171
## Action metadata
189172

@@ -240,7 +223,7 @@ Our action does not require much metadata for it to run correctly. We will not b
240223
</details>
241224

242225
<details id=4>
243-
<summary><strong> Step 4: Create the JavaScript files for your action</strong></summary>
226+
<summary><h2> Step 4: Create the JavaScript files for your action</h2></summary>
244227

245228
## Files
246229

@@ -402,7 +385,7 @@ _Don't forget to call the `run()` function._
402385
</details>
403386
404387
<details id=5>
405-
<summary><strong> Step 5: Add your action to the workflow file</strong></summary>
388+
<summary><h2> Step 5: Add your action to the workflow file</h2></summary>
406389
407390
### Great job!
408391
@@ -438,7 +421,7 @@ jobs:
438421
439422
<details id=6>
440423
441-
<summary><strong> Step 6: Trigger the joke action</strong></summary>
424+
<summary><h2> Step 6: Trigger the joke action</h2></summary>
442425
443426
### Great job!
444427
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.
@@ -453,7 +436,7 @@ Everything is all set up and now we are ready to start laughing. You will find y
453436
</details>
454437
455438
<details id=7>
456-
<summary><strong>Finish</strong></summary>
439+
<summary><h2>Finish</h2></summary>
457440
458441
### Congratulations, you've completed this course!
459442

0 commit comments

Comments
 (0)