Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/github/vscode-github-actions
GitHub Actions extension for VS Code
https://github.com/github/vscode-github-actions
actions github vscode vscode-extension
Last synced: 4 days ago
JSON representation
GitHub Actions extension for VS Code
- Host: GitHub
- URL: https://github.com/github/vscode-github-actions
- Owner: github
- License: mit
- Created: 2023-03-20T20:43:37.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-03T23:23:55.000Z (about 2 months ago)
- Last Synced: 2025-01-10T22:05:17.711Z (11 days ago)
- Topics: actions, github, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions
- Size: 36.3 MB
- Stars: 512
- Watchers: 146
- Forks: 94
- Open Issues: 132
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# GitHub Actions for VS Code
The GitHub Actions extension lets you manage your workflows, view the workflow run history, and helps with authoring workflows.
![](./media/header.png)
## Features
### Manage workflows and runs
* Manage your workflows and runs without leaving your editor.
* Keep track of your CI builds and deployments.
* Investigate failures and view logs.![View workflow runs and logs](./media/workflows.png)
### Workflow authoring
Be more confident when authoring and modifying workflows. Find errors before committing workflows with:
**Syntax highlighting** for workflows and GitHub Actions Expressions makes it clear where values are inserted at execution time:
![Syntax highlighting](media/highlight.png)
**Integrated documentation** for the workflow schema, expression functions, and even event payloads:
![Tooltip showing description for a pull_request payload](media/docs.png)
**Validation and code completion** for the YAML schema and GitHub Actions Expressions. Get instant validation and code completion for the workflow schema, expression functions, event payloads, and job or step `outputs`:
![Validation for YAML keys and expressions](media/validation.png)
**Smart validation and code completion for actions and reusable workflows**: the extension automatically parses parameters, inputs, and outputs for referenced actions and called reusable workflows for code-completion and validation.
![Video showing workflow validation and auto-completion](./media/authoring.gif)
## Getting started
1. Install the extension from the [Marketplace](https://marketplace.visualstudio.com/items?itemName=github.vscode-github-actions).
1. Sign in with your GitHub account and when prompted allow `GitHub Actions` access to your GitHub account.
1. Open a GitHub repository.
1. You will be able to utilize the syntax features in Workflow files, and you can find the GitHub Actions icon on the left navigation to manage your Workflows.## Supported Features
- Manage your workflows and runs
- Edit workflows (syntax highlighting, auto-completion, hovering, and validation)
- Keep track of your CI builds and deployments
- Investigate failures and view logs
- Modify settings like Environments, Secrets, and VariablesUnfortunately, at this time we are not able to support the extension with [remote repositories](https://docs.github.com/en/get-started/getting-started-with-git/about-remote-repositories) (including [github.dev](https://github.dev/) and [vscode.dev](https://vscode.dev/)), so please use the extension with locally downloaded GitHub repositories for the best experience. Please check back here for updates in the future!
We have enabled experimental functionality to support GitHub Enterprise Server, but this feature is an experimental beta and currently unsupported. To try this out, enable the `use-enterprise` setting to authenticate with your `GitHub Enterprise Server Authentication Provider` settings
We currently do not have the capability to support Operating System (OS) certificates or enterprise proxies (we plan to support pulling from the VS Code proxy settings), but we have plans for it in the future and it is on our backlog!
## Contributing
See [CONTRIBUTING.md](CONTRIBUTING.md). A description of the architecture of the extension can be found [here](./docs/project-architecture.md).
## License
This project is licensed under the terms of the MIT open source license. Please refer to [MIT](LICENSE) for the full terms.