Skip to content

Commit

Permalink
docs: Update SonarQube compatibility and add highlights in changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
felipebz committed Feb 7, 2024
1 parent 1399943 commit 7c701c5
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions template/changelog.tpl
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
## SonarQube compatibility

This version supports SonarQube 9.9 LTS and newer.
This version is compatible with SonarQube 9.9 LTS and above, but it is only tested up to SonarQube 10.4 (the current latest release).

Please be aware that ZPA is only tested with SonarQube Community Edition. It may work with the commercial editions of SonarQube, but you won't be able to use ZPA and the embedded PL/SQL plugin from SonarSource to analyze the code simultaneously. If you need this scenario, please use [zpa-cli](https://github.com/felipebz/zpa-cli) instead.

## Highlights

* The property `sonar.zpa.file.suffixes` was renamed to `sonar.plsqlopen.file.suffixes` due to changes in SonarQube 10.4.
* To support the ["Analyzers loading optimization"](https://docs.sonarsource.com/sonarqube/latest/instance-administration/improving-performance/#optimizing-the-loading-of-analyzers) feature from SonarQube 10.4, custom plugins must set the `Plugin-RequiredForLanguages`to `plsqlopen`. See the [Gradle example here](https://github.com/felipebz/zpa/commit/139994305485b47c0ba510946cb5f71bb2d8e8ef#diff-52b816ab2412e08a7c93600c54a68f08bd474bd2a75583a99bd2fea39b92b56b) and the [Maven example here](https://github.com/felipebz/zpa/commit/139994305485b47c0ba510946cb5f71bb2d8e8ef#diff-ed6c67ecd6bc69e0ef1f0a62ce7a8c35602ab8ae3af32dff5acee39e1324c486).

## Install/update instructions

* Download the {{#f_release_download_url}}sonar-zpa-plugin-{{projectVersion}}.jar{{/f_release_download_url}} and copy it to the SONARQUBE_HOME/extensions/plugins.
Expand All @@ -16,6 +21,6 @@ Binary compatibility is not guaranteed either in between any version number chan

Download the {{#f_release_download_url}}zpa-toolkit-{{projectVersion}}.jar{{/f_release_download_url}} (requires Java 11+) to test the parser and view the AST.

## Changelog
## Full changelog

{{changelogChanges}}

0 comments on commit 7c701c5

Please sign in to comment.