Update README with docs page and updated links/images (#119)
Signed-off-by: Sanjula Ganepola <sanjulagane@gmail.com>
This commit is contained in:
Sanjula Ganepola
GitHub
41
README.md
41
README.md
@@ -5,61 +5,64 @@
|
||||
[](https://marketplace.visualstudio.com/items?itemName=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) VS Code 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) Visual Studio Code 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.
|
||||
* ⚡ **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.
|
||||
* ⚙️ **Manage Workflow Settings**: Define secrets, variables, inputs, and runners to be used when executing workflows.
|
||||
* ⚙️ **Manage Workflow Settings**: Define secrets, variables, inputs, runners, payloads, and options for execution.
|
||||
|
||||
✨ Documentation site is now live [here](https://sanjulaganepola.github.io/github-local-actions-docs/)!
|
||||
|
||||
|
||||
|
||||
## Components
|
||||
|
||||
The `Components` view is where you can manage the following components which must be installed and started up before running any GitHub Actions:
|
||||
The `Components` view is where you can manage the components for using the extension.
|
||||
|
||||
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.
|
||||
* [nektos/act](https://github.com/nektos/act) provides the core functionality for running GitHub Actions locally. Whenever a workflow, job, or event is triggered, the extension is essentially building up an act command and executing it as a [VS Code task](https://code.visualstudio.com/docs/editor/tasks).
|
||||
* [Docker Engine](https://docs.docker.com/engine/) is required for nektos/act if you plan to run workflows in containers. 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.
|
||||
|
||||
|
||||
> If you do not require container isolation, you can run selected (e.g. Windows or MacOS) workflow jobs directly on your system. In this case, you do not need to have docker installed or running. Click [here](https://sanjulaganepola.github.io/github-local-actions-docs/usage/settings/#runners) to learn how to use your host system as your runner.
|
||||
|
||||
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
|
||||
|
||||
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.
|
||||
2. **Run Workflow**: Run an entire workflow.
|
||||
2. **Run Single Workflow**: Run a single workflow in the workspace.
|
||||
3. **Run Job**: Run a specific job in a workflow.
|
||||
4. **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).
|
||||
4. **Run Event**: Run multiple workflows using a [GitHub event](https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows).
|
||||
|
||||
|
||||
|
||||
## History
|
||||
|
||||
The `History` view is where you can manage workflows currently being executed as well as review logs from previous workflow runs.
|
||||
The `History` view is where you can browse and manage workflows currently being executed as well as review logs from previous workflow runs.
|
||||
|
||||
|
||||
|
||||
## Settings
|
||||
|
||||
The `Settings` view is where you can set [secrets](https://nektosact.com/usage/index.html#secrets), [variables](https://nektosact.com/usage/index.html#vars), [inputs](https://nektosact.com/usage/index.html#pass-inputs-to-manually-triggered-workflows), and [runners](https://nektosact.com/usage/runners.html) to be used when executing workflows.
|
||||
The `Settings` view is where you can configure various settings to be used when executing workflows.
|
||||
|
||||
> 🚨 Checkout the [nektos/act](https://nektosact.com) documentation for more details on how these various settings are handled. In particular, refer to how secrets can be provided to workflows interactively, as environment variables, or from a file.
|
||||
* [Secrets](https://sanjulaganepola.github.io/github-local-actions-docs/usage/settings/#secrets): Configure sensitive information used in workflows.
|
||||
* [Variables](https://sanjulaganepola.github.io/github-local-actions-docs/usage/settings/#variables): Define workflow variables and import from GitHub.
|
||||
* [Inputs](https://sanjulaganepola.github.io/github-local-actions-docs/usage/settings/#inputs): Assign input values for workflow runs.
|
||||
* [Runners](https://sanjulaganepola.github.io/github-local-actions-docs/usage/settings/#runners): Customize runners for executing workflows.
|
||||
* [Paylods](https://sanjulaganepola.github.io/github-local-actions-docs/usage/settings/#payloads): Configure payloads that define event properties.
|
||||
* [Options](https://sanjulaganepola.github.io/github-local-actions-docs/usage/settings/#options): Define additional act options related to cache, artifacts, containers, etc.
|
||||
|
||||
|
||||
|
||||
## Bugs and Feature Requests
|
||||
|
||||
Feel free to share any bugs or feature requests in the project's [GitHub Issues](https://github.com/SanjulaGanepola/github-local-actions/issues) page.
|
||||
If you encounter any issues or have feature requests specific to GitHub Local Actions, please feel free to [open an issue](https://github.com/SanjulaGanepola/github-local-actions/issues) or post on the [discussion board](https://github.com/SanjulaGanepola/github-local-actions/discussions).
|
||||
|
||||
> 🚨 For any bugs or feature requests related to nektos/act specifically, refer to its dedicated [GitHub Issues](https://github.com/nektos/act/issues) page.
|
||||
> 🚨 For any bugs or feature requests related to nektos/act specifically, please open an issue on the [nektos/act](https://github.com/nektos/act/issues) repository.
|
||||
|
||||
## Contribution
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 405 KiB After Width: | Height: | Size: 557 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 46 KiB After Width: | Height: | Size: 365 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 242 KiB After Width: | Height: | Size: 275 KiB |
Reference in New Issue
Block a user