From 395bfd2baeee8da34a2aa1a5d34043c1ec461c1d Mon Sep 17 00:00:00 2001 From: Sanjula Ganepola <32170854+SanjulaGanepola@users.noreply.github.com> Date: Tue, 24 Dec 2024 11:48:19 -0500 Subject: [PATCH] Document GitHub Local Actions integration (#39) * Document GitHub Local Actions integration Signed-off-by: Sanjula Ganepola * Fix wording Signed-off-by: Sanjula Ganepola * Remove emojis, update link, and update slogan Signed-off-by: Sanjula Ganepola * Update src/integrations.md Co-authored-by: Casey Lee * Update link Signed-off-by: Sanjula Ganepola --------- Signed-off-by: Sanjula Ganepola Signed-off-by: Sanjula Ganepola Co-authored-by: Casey Lee --- src/integrations.md | 1 + src/introduction.md | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/src/integrations.md b/src/integrations.md index d05c21c..bc674f6 100644 --- a/src/integrations.md +++ b/src/integrations.md @@ -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/) diff --git a/src/introduction.md b/src/introduction.md index b1bda3f..7ef1c65 100644 --- a/src/introduction.md +++ b/src/introduction.md @@ -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](). 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.