Skip to content

Blarc/gitlab-template-lint-plugin

Repository files navigation

Gitlab Template Lint

Gitlab Template Lint for IntelliJ based IDEs/Android Studio.

Build Status


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

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
  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

Change log

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

License

Please see LICENSE for details.