From 5ce39f621cff7a8ddfca64f8659bfe534987c5b3 Mon Sep 17 00:00:00 2001 From: Sanjula Ganepola <32170854+SanjulaGanepola@users.noreply.github.com> Date: Sun, 19 Jan 2025 16:21:28 -0500 Subject: [PATCH] Add GitHub Local Actions to README (#2588) * Add GitHub Local Actions to README Signed-off-by: Sanjula Ganepola * Remove trailing whitespace Signed-off-by: Sanjula Ganepola * Add line break after heading Signed-off-by: Sanjula Ganepola * Restore final new line Signed-off-by: Sanjula Ganepola --------- Signed-off-by: Sanjula Ganepola Signed-off-by: Sanjula Ganepola Co-authored-by: Casey Lee --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index a04c43b..26159e9 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ 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`! +> [!TIP] +> **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.