Skip to content

Commit aac4204

Browse files
committed
Update README
1 parent 245268e commit aac4204

File tree

1 file changed

+15
-3
lines changed

1 file changed

+15
-3
lines changed

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

33
A collection of GitHub Actions workflows demonstrating various capabilities and features.
44

5-
They serve as a quickstart and reference for my future self. Each workflow is described below.
6-
75
## basic.yml
86

97
A basic workflow to do the essentials.
@@ -16,6 +14,8 @@ A basic workflow to do the essentials.
1614
- Installs `requirements.txt` and runs a simple test
1715
- Includes `dependabot.yml` to automatically check for package updates
1816

17+
[.github/workflows/basic.yml](.github/workflows/basic.yml)
18+
1919
## branch_name.yml
2020

2121
Getting the branch name is a common CI operation. Surprisingly, there's no pre-defined way to get it in GitHub Actions.
@@ -31,6 +31,8 @@ You may also get an unexpected result depending on the event that triggered the
3131
- Shows various `github` context properties that may or may not contain the branch name
3232
- Sets branch name to the top level `env` so it can be accessed by the entire workflow
3333

34+
[.github/workflows/branch_name.yml](.github/workflows/branch_name.yml)
35+
3436
## context.yml
3537

3638
Contexts are a way to access information about workflow runs, variables, runner environments, jobs, and steps.
@@ -41,6 +43,8 @@ This can be helpful for debugging workflow errors or bugs.
4143
4244
- Shows various contexts
4345

46+
[.github/workflows/context.yml](.github/workflows/context.yml)
47+
4448
## env_var.yml
4549

4650
Environment variables and their scopes work as you'd expect in GitHub Actions.
@@ -53,14 +57,18 @@ One quirk that can cause confusion is the fact that environment variables define
5357
- Write env vars
5458
- Pass env vars
5559

60+
[.github/workflows/env_var.yml](.github/workflows/env_var.yml)
61+
5662
## github_script.yml
5763

5864
GitHub provides an action that lets you easily write javascript directly in your workflow.
5965

60-
The action includes an object with the current workflow context and references to several other useful packages. It's also a pre-authenticated octokit/rest.js client.
66+
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.
6167

6268
- Uses [actions/github-script](https://github.com/actions/github-script)
6369

70+
[.github/workflows/github_script.yml](.github/workflows/github_script.yml)
71+
6472
## homebrew.yml
6573

6674
If you develop on macOS you're probably familiar with [homebrew](https://brew.sh). Did you know it's also available on Linux?
@@ -69,12 +77,16 @@ This demo shows how you can leverage its power and convenience to install applic
6977

7078
- Uses [Homebrew/actions/setup-homebrew](https://github.com/Homebrew/actions/tree/master/setup-homebrew)
7179

80+
[.github/workflows/homebrew.yml](.github/workflows/homebrew.yml)
81+
7282
## system_path.yml
7383

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

7686
- Modify PATH env var
7787

88+
[.github/workflows/system_path.yml](.github/workflows/system_path.yml)
89+
7890
## References
7991

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

0 commit comments

Comments
 (0)