Skip to content

Commit

Permalink
[chore] Update plugin description.
Browse files Browse the repository at this point in the history
  • Loading branch information
Blarc committed Jun 28, 2022
1 parent 136bdfe commit 14eda41
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 26 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## [Unreleased]
### Changed
- Updated readme.
- Updated plugin description.

## [0.0.7]
### Fixed
Expand Down
7 changes: 0 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,12 @@
- [Demo](#demo)

## Description
<!-- Plugin 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 <kbd>read_api</kbd> and <kbd>api</kbd> scope in plugin's settings:
<kbd>Settings</kbd> > <kbd>Tools</kbd> > <kbd>Gitlab Template Lint</kbd>
<!-- Plugin description end -->

## Compatibility
IntelliJ IDEA, PhpStorm, WebStorm, PyCharm, RubyMine, AppCode, CLion, Gogland, DataGrip, Rider, MPS, Android Studio, DataSpell, Code With Me
Expand All @@ -55,8 +53,3 @@ For Mac: <kbd>IntelliJ IDEA</kbd> > <kbd>Preferences</kbd> > <kbd>Plugins</kbd>
## Demo

![](./screenshots/plugin.gif)





13 changes: 0 additions & 13 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,6 @@ tasks {
sinceBuild.set(properties("pluginSinceBuild"))
untilBuild.set(properties("pluginUntilBuild"))

// Extract the <!-- Plugin description --> section from README.md and provide for the plugin's manifest
pluginDescription.set(
projectDir.resolve("README.md").readText().lines().run {
val start = "<!-- Plugin description -->"
val end = "<!-- Plugin description end -->"

if (!containsAll(listOf(start, end))) {
throw GradleException("Plugin description section not found in README.md:\n$start ... $end")
}
subList(indexOf(start) + 1, indexOf(end))
}.joinToString("\n").run { markdownToHTML(this) }
)

// Get the latest available change notes from the changelog file
changeNotes.set(provider {
changelog.run {
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

pluginGroup = com.github.blarc
pluginName = GitlabTemplateLint
pluginVersion = 0.0.7
pluginVersion = 0.0.8

# https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
pluginSinceBuild = 212
Expand Down
24 changes: 19 additions & 5 deletions src/main/resources/META-INF/plugin.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,25 @@
<!-- Description of the plugin displayed on the Plugin Page and IDE Plugin Manager.
Simple HTML elements (text formatting, paragraphs, and lists) can be added inside of <![CDATA[ ]]> tag.
Guidelines: https://plugins.jetbrains.com/docs/marketplace/plugin-overview-page.html#plugin-description -->
<description>
<![CDATA[
Intellij plugin for linting Gitlab CI/CD templates.<br>
]]>
</description>
<description><![CDATA[
<p>
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.
</p>
<br/>
<p>
To get started, install the plugin and set Gitlab private token with <strong>read_api</strong> and <strong>api</strong> scope in plugin's settings:
<br/>
Settings > Tools > Gitlab Template Lint
<br/>
</p>
<p>
<img src="https://raw.githubusercontent.com/Blarc/gitlab-lint-plugin/136bdfea2a5fe57ec5cd8e385b3cb6bc9361af5e/screenshots/plugin.gif"
border="0" width="600" alt="Highlight current scope.gif"/></p>
]]></description>

<!-- Product and plugin compatibility requirements.
Read more: https://plugins.jetbrains.com/docs/intellij/plugin-compatibility.html -->
Expand Down

0 comments on commit 14eda41

Please sign in to comment.