Add workflows docs
Signed-off-by: Sanjula Ganepola <sanjulagane@gmail.com>
This commit is contained in:
15
README.md
15
README.md
@@ -8,17 +8,17 @@
|
|||||||
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 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/Jobs**: Run entire workflows or specific jobs locally without leaving your editor.
|
* 🚀 **Run Workflows/Jobs**: Run entire workflows or specific jobs locally without leaving your editor.
|
||||||
* ⚡ **Trigger Events**: Trigger standard GitHub events to run multiple workflows.
|
* ⚡ **Trigger Events**: Trigger standard [GitHub events](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows) to run multiple workflows.
|
||||||
* 📖 **View Workflow Run History**: Track and investigate past workflow logs.
|
* 📖 **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.
|
* ⚙️ **Manage Workflow Settings**: Define secrets, variables, inputs, and runners to be used when executing workflows.
|
||||||
|
|
||||||
## Components
|
## Components
|
||||||
|
|
||||||
To run GitHub Actions locally, you will need the components denoted below. These can be installed and started up from the `Components` view.
|
The `Components` view is where you can manage the components which must be installed and started up before running any GitHub Actions.
|
||||||
|
|
||||||
1. [nektos/act](https://github.com/nektos/act): Act is a CLI tool responsible for executing your workflows locally. It can be installed via several software package managers or using a pre-built artifact.
|
1. [nektos/act](https://github.com/nektos/act): Act is a CLI tool responsible for executing your workflows locally. It can be installed via several software package managers or using a pre-built artifact.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
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:
|
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:
|
||||||
|
|
||||||
@@ -30,6 +30,15 @@ To run GitHub Actions locally, you will need the components denoted below. These
|
|||||||
|
|
||||||
## Workflows
|
## Workflows
|
||||||
|
|
||||||
|
The `Workflows` view is where you can manage and run workflows locally. You have several options to execute a workflow:
|
||||||
|
|
||||||
|
1. **Run All Workflows**: Run all workflows in the workspace.
|
||||||
|
1. **Run Workflow**: Run an entire workflow.
|
||||||
|
2. **Run Job**: Run a specific job in a workflow.
|
||||||
|
3. **Run Event**: Run multiple workflows by triggering a [GitHub event](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## History
|
## History
|
||||||
|
|
||||||
## Settings
|
## Settings
|
||||||
|
|||||||
BIN
images/workflows.png
Normal file
BIN
images/workflows.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 242 KiB |
Reference in New Issue
Block a user