@@ -4,9 +4,9 @@ A collection of GitHub Actions workflows demonstrating various capabilities and
44
55Go to the [ Actions] ( https://github.com/chingc/tutorial-github-actions/actions ) tab for workflow outputs.
66
7- ## basic.yml
7+ < details >
88
9- A basic workflow to do the essentials.
9+ < summary >basic.yml: A basic workflow to do the essentials.</ summary >
1010
1111- Runs when changes are pushed
1212- Runs on a schedule
@@ -18,11 +18,15 @@ A basic workflow to do the essentials.
1818
1919[ .github/workflows/basic.yml] ( .github/workflows/basic.yml )
2020
21- ## branch_name.yml
21+ </details >
22+
23+ <details >
24+
25+ <summary >branch_name.yml: Getting the branch name without 3rd party tools.</summary >
2226
2327Getting the branch name is a common CI operation. Surprisingly, there's no pre-defined way to get it in GitHub Actions.
2428
25- This demo shows the simplest way without using 3rd party actions or invoking various tools.
29+ This demo shows the simplest way without using 3rd party actions or other tools.
2630
2731It works in most cases, but there are some quirks.
2832
@@ -35,9 +39,11 @@ You may also get an unexpected result depending on the event that triggered the
3539
3640[ .github/workflows/branch_name.yml] ( .github/workflows/branch_name.yml )
3741
38- ## context.yml
42+ </details >
43+
44+ <details >
3945
40- Contexts are a way to access information about workflow runs, variables, runner environments, jobs, and steps.
46+ < summary >context.yml: Access information about workflow runs, variables, runner environments, jobs, and steps.</ summary >
4147
4248This can be helpful for debugging workflow errors or bugs.
4349
@@ -47,9 +53,11 @@ This can be helpful for debugging workflow errors or bugs.
4753
4854[ .github/workflows/context.yml] ( .github/workflows/context.yml )
4955
50- ## env_var.yml
56+ </ details >
5157
52- Environment variables and their scopes work as you'd expect in GitHub Actions.
58+ <details >
59+
60+ <summary >env_var.yml: Environment variables and their scopes work as you'd expect in GitHub Actions.</summary >
5361
5462They're also fairly self-contained, so any changes you make are isolated to the job you're in.
5563
@@ -61,17 +69,23 @@ One quirk that can cause confusion is the fact that environment variables define
6169
6270[ .github/workflows/env_var.yml] ( .github/workflows/env_var.yml )
6371
64- ## github_script.yml
72+ </details >
73+
74+ <details >
6575
66- GitHub provides an action that lets you easily write javascript directly in your workflow.
76+ < summary >github_script.yml: GitHub provides an action that lets you easily write javascript directly in your workflow.</ summary >
6777
6878The 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.
6979
7080- Uses [ actions/github-script] ( https://github.com/actions/github-script )
7181
7282[ .github/workflows/github_script.yml] ( .github/workflows/github_script.yml )
7383
74- ## homebrew.yml
84+ </details >
85+
86+ <details >
87+
88+ <summary >homebrew.yml: tbd</summary >
7589
7690If you develop on macOS you're probably familiar with [ homebrew] ( https://brew.sh ) . Did you know it's also available on Linux?
7791
@@ -81,14 +95,20 @@ This demo shows how you can leverage its power and convenience to install applic
8195
8296[ .github/workflows/homebrew.yml] ( .github/workflows/homebrew.yml )
8397
84- ## system_path.yml
98+ </details >
99+
100+ <details >
101+
102+ <summary >system_path.yml: tbd</summary >
85103
86104Read, write, and modify PATH like any other environment variable. It has the same quirks.
87105
88106- Modify PATH env var
89107
90108[ .github/workflows/system_path.yml] ( .github/workflows/system_path.yml )
91109
110+ </details >
111+
92112## References
93113
94114- [ GitHub Docs: GitHub Actions] ( https://docs.github.com/en/actions )
0 commit comments