Skip to content

Commit c0d3995

Browse files
committed
Make sections collapsible
1 parent f3a491d commit c0d3995

File tree

1 file changed

+36
-10
lines changed

1 file changed

+36
-10
lines changed

README.md

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,11 @@ Go to the [Actions](https://github.com/chingc/tutorial-github-actions/actions) t
66

77
## basic.yml
88

9-
A basic workflow to do the essentials.
9+
<details>
10+
11+
<summary>A basic workflow to do the essentials.\</summary>
12+
13+
If you're unfamiliar with GitHub Actions this will help you get started quickly.
1014

1115
- Runs when changes are pushed
1216
- Runs on a schedule
@@ -18,11 +22,17 @@ A basic workflow to do the essentials.
1822

1923
[.github/workflows/basic.yml](.github/workflows/basic.yml)
2024

25+
</details>
26+
2127
## branch_name.yml
2228

29+
<details>
30+
31+
<summary>Getting the branch name without 3rd party tools.</summary>
32+
2333
Getting the branch name is a common CI operation. Surprisingly, there's no pre-defined way to get it in GitHub Actions.
2434

25-
This demo shows the simplest way without using 3rd party actions or invoking various tools.
35+
This demo shows the simplest way without using 3rd party actions or other tools.
2636

2737
It works in most cases, but there are some quirks.
2838

@@ -35,9 +45,11 @@ You may also get an unexpected result depending on the event that triggered the
3545

3646
[.github/workflows/branch_name.yml](.github/workflows/branch_name.yml)
3747

38-
## context.yml
48+
</details>
49+
50+
<details>
3951

40-
Contexts are a way to access information about workflow runs, variables, runner environments, jobs, and steps.
52+
<summary>context.yml: Access information about workflow runs, variables, runner environments, jobs, and steps.</summary>
4153

4254
This can be helpful for debugging workflow errors or bugs.
4355

@@ -47,9 +59,11 @@ This can be helpful for debugging workflow errors or bugs.
4759

4860
[.github/workflows/context.yml](.github/workflows/context.yml)
4961

50-
## env_var.yml
62+
</details>
63+
64+
<details>
5165

52-
Environment variables and their scopes work as you'd expect in GitHub Actions.
66+
<summary>env_var.yml: Environment variables and their scopes work as you'd expect in GitHub Actions.</summary>
5367

5468
They're also fairly self-contained, so any changes you make are isolated to the job you're in.
5569

@@ -61,17 +75,23 @@ One quirk that can cause confusion is the fact that environment variables define
6175

6276
[.github/workflows/env_var.yml](.github/workflows/env_var.yml)
6377

64-
## github_script.yml
78+
</details>
6579

66-
GitHub provides an action that lets you easily write javascript directly in your workflow.
80+
<details>
81+
82+
<summary>github_script.yml: GitHub provides an action that lets you easily write javascript directly in your workflow.</summary>
6783

6884
The action also includes an object with the current workflow context, references to other useful packages, and it's a pre-authenticated octokit/rest.js client.
6985

7086
- Uses [actions/github-script](https://github.com/actions/github-script)
7187

7288
[.github/workflows/github_script.yml](.github/workflows/github_script.yml)
7389

74-
## homebrew.yml
90+
</details>
91+
92+
<details>
93+
94+
<summary>homebrew.yml: tbd</summary>
7595

7696
If you develop on macOS you're probably familiar with [homebrew](https://brew.sh). Did you know it's also available on Linux?
7797

@@ -81,14 +101,20 @@ This demo shows how you can leverage its power and convenience to install applic
81101

82102
[.github/workflows/homebrew.yml](.github/workflows/homebrew.yml)
83103

84-
## system_path.yml
104+
</details>
105+
106+
<details>
107+
108+
<summary>system_path.yml: tbd</summary>
85109

86110
Read, write, and modify PATH like any other environment variable. It has the same quirks.
87111

88112
- Modify PATH env var
89113

90114
[.github/workflows/system_path.yml](.github/workflows/system_path.yml)
91115

116+
</details>
117+
92118
## References
93119

94120
- [GitHub Docs: GitHub Actions](https://docs.github.com/en/actions)

0 commit comments

Comments
 (0)