diff --git a/README.md b/README.md index 6ecc148..7f58cec 100644 --- a/README.md +++ b/README.md @@ -5,21 +5,39 @@ [![Version](https://img.shields.io/visual-studio-marketplace/v/SanjulaGanepola.github-local-actions)](https://marketplace.visualstudio.com/items?itemName=SanjulaGanepola.github-local-actions) [![Installs](https://img.shields.io/visual-studio-marketplace/i/SanjulaGanepola.github-local-actions)](https://marketplace.visualstudio.com/items?itemName=SanjulaGanepola.github-local-actions) -Run your GitHub Actions locally with the power of the [GitHub Local Actions](https://marketplace.visualstudio.com/items?itemName=SanjulaGanepola.github-local-actions) extension! +Run your GitHub Actions locally with the power of the [GitHub Local Actions](https://marketplace.visualstudio.com/items?itemName=SanjulaGanepola.github-local-actions) VSCode extension! Say goodbye to the hassle of committing and pushing changes every time you need to test a workflow. This extension lets you quickly and efficiently run your workflows locally, leveraging the [nektos/act](https://github.com/nektos/act) CLI tool. Enjoy a seamless experience with an interface designed to feel as familiar as the official [GitHub Actions](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions) extension. -* Run Workflows: -* View Workflow Run History: -* Manage Secrets, Variables, and Inputs: +* 🚀 **Run Workflows/Jobs**: Run entire workflows or specific jobs locally without leaving your editor. +* ⚡ **Trigger Events**: Trigger standard GitHub events to run multiple workflows. +* 📖 **View Workflow Run History**: Track and investigate past workflow logs. +* ⚙️ **Manage Workflow Settings**: Define secrets, variables, inputs, and runners to be used when executing workflows. -## Getting Started +## Components -> [!IMPORTANT] -> WORK IN PROGRESS +To run GitHub Actions locally, you will need the following components which can be managed from the `Components` view: +1. [nektos/act](https://github.com/nektos/act) + + Act is a CLI tool responsible for executing your workflows locally. -## Extension Settings +
+ Act Installation +
-> [!IMPORTANT] -> WORK IN PROGRESS +2. [Docker Engine](https://docs.docker.com/engine/) + + Docker Engine is required for act to function as it uses Docker to handle workflow execution. The process includes: + + * Pulling or building the images specified in your workflow files + * Determining the execution path based on your workflow's dependencies + * Running containers for each action using the prepared images + + The containers are configured to mirror GitHub's environment, including matching [environment variables](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#default-environment-variables) and [filesystems](https://docs.github.com/en/actions/using-github-hosted-runners/using-github-hosted-runners#file-systems), ensuring a consistent and reliable local execution. + +## Workflows + +## History + +## Settings ## Bugs and Feature Requests