DevInfra/github-local-actions
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source 
Signed-off-by: Sanjula Ganepola <sanjulagane@gmail.com>
This commit is contained in:
Sanjula Ganepola
2024-11-17 17:05:35 -05:00
parent df9c15a275
commit 0eda6ec17a
1 changed files with 28 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@@ -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
<div style="text-align: center; margin: 20px;">
<img src="https://github.com/SanjulaGanepola/github-local-actions/blob/main/images/act-installation.png?raw=true" alt="Act Installation" style="box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2); border-radius: 8px; max-width: 100%; display: block; margin-bottom: 20px;">
</div>
> [!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