Skip to content

Commit

Permalink
Document GitHub Local Actions integration (#39)
Browse files Browse the repository at this point in the history
* Document GitHub Local Actions integration

Signed-off-by: Sanjula Ganepola <[email protected]>

* Fix wording

Signed-off-by: Sanjula Ganepola <[email protected]>

* Remove emojis, update link, and update slogan

Signed-off-by: Sanjula Ganepola <[email protected]>

* Update src/integrations.md

Co-authored-by: Casey Lee <[email protected]>

* Update link

Signed-off-by: Sanjula Ganepola <[email protected]>

---------

Signed-off-by: Sanjula Ganepola <[email protected]>
Signed-off-by: Sanjula Ganepola <[email protected]>
Co-authored-by: Casey Lee <[email protected]>
  • Loading branch information
SanjulaGanepola and cplee authored Dec 24, 2024
1 parent b927bd7 commit 395bfd2
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@
- [Gitea Actions runner](https://gitea.com/gitea/act_runner)
- [github-act-runner](https://github.com/ChristopherHX/github-act-runner)
- [Gradle Act plugin](https://github.com/pshevche/gradle-act-plugin)
- [GitHub Local Actions for Visual Studio Code](https://sanjulaganepola.github.io/github-local-actions-docs/)
7 changes: 7 additions & 0 deletions src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ Run your [GitHub Actions](https://developer.github.com/actions/) locally! Why wo
- **Fast Feedback** - Rather than having to commit/push every time you want to test out the changes you are making to your `.github/workflows/` files (or for any changes to embedded GitHub actions), you can use `act` to run the actions locally. The [environment variables](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables) and [filesystem](https://help.github.com/en/actions/reference/virtual-environments-for-github-hosted-runners#filesystems-on-github-hosted-runners) are all configured to match what GitHub provides.
- **Local Task Runner** - I love [make](<https://en.wikipedia.org/wiki/Make_(software)>). However, I also hate repeating myself. With `act`, you can use the GitHub Actions defined in your `.github/workflows/` to replace your `Makefile`!

---

> **Now Manage and Run Act Directly From VS Code!**
> Check out the [GitHub Local Actions](https://sanjulaganepola.github.io/github-local-actions-docs/) Visual Studio Code extension which allows you to leverage the power of `act` to run and test workflows locally without leaving your editor.
---

# How Does It Work?

When you run `act` it reads in your GitHub Actions from `.github/workflows/` and determines the set of actions that need to be run. It uses the Docker API to either pull or build the necessary images, as defined in your workflow files and finally determines the execution path based on the dependencies that were defined. Once it has the execution path, it then uses the Docker API to run containers for each action based on the images prepared earlier. The [environment variables](https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables) and [filesystem](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#file-systems) are all configured to match what GitHub provides.
Expand Down

0 comments on commit 395bfd2

Please sign in to comment.