Add GitHub Local Actions to README (#2588)

* Add GitHub Local Actions to README Signed-off-by: Sanjula Ganepola <[email protected]> * Remove trailing whitespace Signed-off-by: Sanjula Ganepola <[email protected]> * Add line break after heading Signed-off-by: Sanjula Ganepola <[email protected]> * Restore final new line 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]>
nektos · Jan 19, 2025 · 5ce39f6 · 5ce39f6
1 parent a9e31cd
commit 5ce39f6
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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](<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`!
 
+> [!TIP]
+> **Now Manage and Run Act Directly From VS Code!**<br/>
+> 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.