GitHub Actions YAML Extension
Provides Github Actions YAML support via yaml-language-server.
Features
1. YAML validation
- Apply schema validation to GitHub Actions
- Detects errors such as:
- Invalid property value type
- Out of enum scope
- Required property is missing
- Unexpected property
2. Auto completion
- Generate input template for whole GitHub Action
- Generate input template for an object (if provided by schema)
Including required properties and optional properties with default value
- Support properties intellisense (if provided by schema)
- Enumerated property value recommendation (if provided by schema)
Intellisense is automatically triggered by what you have typed, but you can also hit Ctrl + Space to get what you can type.
3. Hover support
- Hovering over a property shows description (if provided by schema)
Developer support
Install prerequisites:
Fork this repository.
Build this project.
# clone your forked repository
$ git clone https://github.com/{your-github-name}/vscode-github-actions
$ cd vscode-github-actions
# install npm dependencies
$ npm install
# compile
$ npm run compile
# open the project in vscode
$ code .
Make changes as necessary and the run the code using F5.
Refer to VS Code documentation on how to run and debug the extension.
Create a pull-request to this repository and we will review, merge it and publish new version extension regularly.
License
MIT
All contributions are welcome!
| |
