An open API service indexing awesome lists of open source software.

https://github.com/blarc/gitlab-template-lint-plugin

Intellij plugin for linting Gitlab CI/CD yaml templates.
https://github.com/blarc/gitlab-template-lint-plugin

gitlab gitlab-ci intellij intellij-plugin jetbrains lint yaml

Last synced: about 1 month ago
JSON representation

Intellij plugin for linting Gitlab CI/CD yaml templates.

Awesome Lists containing this project

README

        



logo


Gitlab Template Lint


Gitlab Template Lint for IntelliJ based IDEs/Android Studio.


Build Status





- [Description](#description)
- [Features](#features)
- [Demo](#demo)
- [Compatibility](#compatibility)
- [Install](#install)
- [Installation from zip](#installation-from-zip)
- [How does it work](/docs/how-does-it-work.md)
- [Configuration](/docs/configuration.md)

## Description
Gitlab Template Lint Plugin is a plugin for IntelliJ based IDEs/Android studio for linting
Gitlab CI/CD yaml configuration files. It uses the Gitlab lint API to check the currently
open yaml configuration and shows the errors in the notification bar.

To get started, install the plugin and set Gitlab private token with read_api and api scope in plugin's settings:
Settings > Tools > Gitlab Template Lint

## Features
- Linting of Gitlab CI/CD yaml configuration files
- Preview of the merged Gitlab CI/CD yaml configuration files
- Setting inclusion and exclusion globs for linting
- Multiple Gitlab instances support

## Demo

![demo.gif](./screenshots/plugin2.gif)

## Compatibility
IntelliJ IDEA, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, GoLand, DataGrip, Rider, MPS, Android Studio, DataSpell, Code With Me

## Install


Or you could install it inside your IDE:

For Windows & Linux: File > Settings > Plugins > Marketplace > Search for "Gitlab Template Lint" > Install Plugin > Restart IntelliJ IDEA

For Mac: IntelliJ IDEA > Preferences > Plugins > Marketplace > Search for "Gitlab Template Lint" > Install Plugin > Restart IntelliJ IDEA

## Installation from zip
1. Download zip from [releases](https://github.com/Blarc/gitlab-lint-plugin/releases)
2. Import to IntelliJ: Settings > Plugins > Cog > Install plugin from disk...
3. Set Gitlab private token in plugin's settings: Settings > Tools > Gitlab Template Lint

## Support

* Star the repository
* [Rate the plugin](https://plugins.jetbrains.com/plugin/19411-gitlab-template-lint)
* [Share the plugin](https://plugins.jetbrains.com/plugin/19411-gitlab-template-lint)
* [Buy me a coffee](https://ko-fi.com/blarc)

## Change log

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

## Contributing

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## License

Please see [LICENSE](LICENSE) for details.