Skip to content

Commit

Permalink
release 6.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Lightning- committed Oct 8, 2024
1 parent d11673c commit f1d7409
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 52 deletions.
27 changes: 25 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,30 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [6.0.0] - 2024-10-08

### Added
- SonarQube Scanner support
- Dependency [marktlib](https://github.com/markt-de/puppet-marktlib/)

### Changed
- Update PDK to 3.2.0
- Update module dependencies (incl. [#35])
- DSL modernization/rework
- CI workflow modernization/rework

### Removed
- Legacy os support
- SonarQube Runner support

### Fixed
- Stdlib deprecations for `ensure_packages()`
- GitHub Actions (unit+acceptance tests)
- Various paths for recent (OS and SonarQube) installations

## [5.3.0] - 2023-08-08

### Changed
Expand Down Expand Up @@ -156,7 +177,8 @@ migrate from maestrodev/sonarqube to this version with only minor modifications.
### Fixed
- Fixes for SonarQube 7.9 LTS ([#1])

[Unreleased]: https://github.com/markt-de/puppet-sonarqube/compare/v5.3.0...HEAD
[Unreleased]: https://github.com/markt-de/puppet-sonarqube/compare/v6.0.0...HEAD
[6.0.0]: https://github.com/markt-de/puppet-sonarqube/compare/v5.3.0...v6.0.0
[5.3.0]: https://github.com/markt-de/puppet-sonarqube/compare/v5.2.0...v5.3.0
[5.2.0]: https://github.com/markt-de/puppet-sonarqube/compare/v5.1.0...v5.2.0
[5.1.0]: https://github.com/markt-de/puppet-sonarqube/compare/v5.0.0...v5.1.0
Expand All @@ -166,6 +188,7 @@ migrate from maestrodev/sonarqube to this version with only minor modifications.
[4.0.0]: https://github.com/markt-de/puppet-sonarqube/compare/v3.1.0...v4.0.0
[3.1.0]: https://github.com/markt-de/puppet-sonarqube/compare/v3.0.0...v3.1.0
[3.0.0]: https://github.com/markt-de/puppet-sonarqube/compare/v2.6.7...v3.0.0
[#35]: https://github.com/markt-de/puppet-sonarqube/pull/35
[#29]: https://github.com/markt-de/puppet-sonarqube/pull/29
[#28]: https://github.com/markt-de/puppet-sonarqube/pull/28
[#27]: https://github.com/markt-de/puppet-sonarqube/pull/27
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ A puppet module to install and configure [SonarQube](https://www.sonarqube.org/)

The main goal is compatibility with the latest LTS release of SonarQube. Older versions are not supported. However, newer versions should usually work too.

Note that as of release 6.0.0:
- SonarQube Runner is nowadays called SonarQube Scanner and class names, variable names, download urls etc. are changed/renamed accordingly
- Java 17 is now required as runtime environment

## Usage

### Basic usage
Expand Down
98 changes: 49 additions & 49 deletions REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@
#### Public Classes

* [`sonarqube`](#sonarqube): Install and configure SonarQube and additional components
* [`sonarqube::runner`](#sonarqube--runner): Install and configure SonarQube Runner
* [`sonarqube::scanner`](#sonarqube--scanner): Install and configure SonarQube Scanner

#### Private Classes

* `sonarqube::config`: Configure SonarQube
* `sonarqube::install`: Install SonarQube package
* `sonarqube::runner::config`: Configuration of SonarQube Runner
* `sonarqube::runner::install`: Installation of SonarQube Runner
* `sonarqube::scanner::config`: Configuration of SonarQube Scanner
* `sonarqube::scanner::install`: Installation of SonarQube Scanner
* `sonarqube::service`: Setup SonarQube service

### Defined types
Expand Down Expand Up @@ -76,15 +76,15 @@ The following parameters are available in the `sonarqube` class:

##### <a name="-sonarqube--arch"></a>`arch`

Data type: `String`
Data type: `String[1]`

Specifies the architecture of the installation archive that should be
downloaded.
Default: Automatically selected depending on the OS architecture.

##### <a name="-sonarqube--ce_java_opts"></a>`ce_java_opts`

Data type: `Optional[String]`
Data type: `Optional[String[1]]`

Optional JVM options for the Compute Engine.

Expand All @@ -100,7 +100,7 @@ Default value: `undef`

##### <a name="-sonarqube--config"></a>`config`

Data type: `Optional[String]`
Data type: `Optional[String[1]]`

Allow to specify an alternative SonarQube configuration, effectively
replacing all contens of `sonar.properies`.
Expand All @@ -109,7 +109,7 @@ Default value: `undef`

##### <a name="-sonarqube--context_path"></a>`context_path`

Data type: `String`
Data type: `String[1]`

Specifies the context path for the application.

Expand All @@ -128,32 +128,32 @@ The directory where the SonarQube installation archive should be stored.

##### <a name="-sonarqube--download_url"></a>`download_url`

Data type: `String`
Data type: `String[1]`

The URL from which the SonarQube installation archive should be downloaded.

##### <a name="-sonarqube--edition"></a>`edition`

Data type: `String`
Data type: `String[1]`

Specifies the edition of SonarQube that should be installed.
Default: `community`

##### <a name="-sonarqube--group"></a>`group`

Data type: `String`
Data type: `String[1]`

The group for the SonarQube application.

##### <a name="-sonarqube--home"></a>`home`

Data type: `String`
Data type: `String[1]`

SonarQube's data directory.

##### <a name="-sonarqube--host"></a>`host`

Data type: `Optional[String]`
Data type: `Optional[String[1]]`

Specifies the listen address for SonarQube.

Expand Down Expand Up @@ -198,7 +198,7 @@ Specifies the log directory for SonarQube.

##### <a name="-sonarqube--distribution_name"></a>`distribution_name`

Data type: `String`
Data type: `String[1]`

Specifies the basename of the SonarQube archive.

Expand All @@ -218,13 +218,13 @@ download plugin files again after `/tmp` was purged.

##### <a name="-sonarqube--port"></a>`port`

Data type: `Integer`
Data type: `Variant[Stdlib::Port, Integer[-1, 0]]`

Specifies the TCP port for SonarQube.

##### <a name="-sonarqube--portajp"></a>`portajp`

Data type: `Integer`
Data type: `Variant[Stdlib::Port, Integer[-1, 0]]`

Specifies the port to use for the AJP communication protocol.

Expand All @@ -236,27 +236,27 @@ Specifies wether profiling should be enabled for SonarQube.

##### <a name="-sonarqube--search_host"></a>`search_host`

Data type: `String`
Data type: `String[1]`

Specifies the IP/hostname of the Elasticsearch server.

##### <a name="-sonarqube--search_java_opts"></a>`search_java_opts`

Data type: `Optional[String]`
Data type: `Optional[String[1]]`

Optional JVM options for the Elasticsearch server.

Default value: `undef`

##### <a name="-sonarqube--search_port"></a>`search_port`

Data type: `Integer`
Data type: `Variant[Stdlib::Port, Integer[-1, 0]]`

Specifies the TCP port of the Elasticsearch server.

##### <a name="-sonarqube--service"></a>`service`

Data type: `String`
Data type: `String[1]`

Specifies the name of the SonarQube system service.

Expand All @@ -282,13 +282,13 @@ Specifies whether to enable the Update Center.

##### <a name="-sonarqube--pidfile"></a>`pidfile`

Data type: `String`
Data type: `String[1]`

Specifies the name of the PID file.

##### <a name="-sonarqube--user"></a>`user`

Data type: `String`
Data type: `String[1]`

The user for the SonarQube application.

Expand All @@ -300,23 +300,23 @@ Specifies whether the SonarQube user should be a system user.

##### <a name="-sonarqube--version"></a>`version`

Data type: `String`
Data type: `String[1]`

Specifies the version of SonarQube that should be installed/updated.
Expects a 4 digit version number (1.2.3.4), which can be found on the
SonarQube download page.

##### <a name="-sonarqube--web_java_opts"></a>`web_java_opts`

Data type: `Optional[String]`
Data type: `Optional[String[1]]`

Optional JVM options for SonarQube's web server.

Default value: `undef`

##### <a name="-sonarqube--search_java_additional_opts"></a>`search_java_additional_opts`

Data type: `Optional[String]`
Data type: `Optional[String[1]]`

Optional JVM options for embedded elasticsearch server.

Expand All @@ -330,61 +330,61 @@ Specifies the directory for Sonarqube Helper scripts.

##### <a name="-sonarqube--system_passcode"></a>`system_passcode`

Data type: `Optional[String]`
Data type: `Optional[String[1]]`

Optional system_passcode setting for monitoring.

Default value: `undef`

### <a name="sonarqube--runner"></a>`sonarqube::runner`
### <a name="sonarqube--scanner"></a>`sonarqube::scanner`

Install and configure SonarQube Runner
Install and configure SonarQube Scanner

#### Parameters

The following parameters are available in the `sonarqube::runner` class:
The following parameters are available in the `sonarqube::scanner` class:

* [`distribution_name`](#-sonarqube--runner--distribution_name)
* [`download_url`](#-sonarqube--runner--download_url)
* [`installroot`](#-sonarqube--runner--installroot)
* [`jdbc`](#-sonarqube--runner--jdbc)
* [`sonarqube_server`](#-sonarqube--runner--sonarqube_server)
* [`version`](#-sonarqube--runner--version)
* [`distribution_name`](#-sonarqube--scanner--distribution_name)
* [`download_url`](#-sonarqube--scanner--download_url)
* [`installroot`](#-sonarqube--scanner--installroot)
* [`jdbc`](#-sonarqube--scanner--jdbc)
* [`sonarqube_server`](#-sonarqube--scanner--sonarqube_server)
* [`version`](#-sonarqube--scanner--version)

##### <a name="-sonarqube--runner--distribution_name"></a>`distribution_name`
##### <a name="-sonarqube--scanner--distribution_name"></a>`distribution_name`

Data type: `String`
Data type: `String[1]`

Specifies the basename of the installation archive.

##### <a name="-sonarqube--runner--download_url"></a>`download_url`
##### <a name="-sonarqube--scanner--download_url"></a>`download_url`

Data type: `String`
Data type: `String[1]`

The URL from which the installation archive should be downloaded.

##### <a name="-sonarqube--runner--installroot"></a>`installroot`
##### <a name="-sonarqube--scanner--installroot"></a>`installroot`

Data type: `Stdlib::Absolutepath`

Specifies the base directory where it should be installed. A new
subdirectory for each version will be created.

##### <a name="-sonarqube--runner--jdbc"></a>`jdbc`
##### <a name="-sonarqube--scanner--jdbc"></a>`jdbc`

Data type: `Hash`

Specifies the database configuration.

##### <a name="-sonarqube--runner--sonarqube_server"></a>`sonarqube_server`
##### <a name="-sonarqube--scanner--sonarqube_server"></a>`sonarqube_server`

Data type: `String`
Data type: `String[1]`

The URL for the default SonarQube server.

##### <a name="-sonarqube--runner--version"></a>`version`
##### <a name="-sonarqube--scanner--version"></a>`version`

Data type: `String`
Data type: `String[1]`

Specifies the version that should be installed/updated.

Expand Down Expand Up @@ -424,7 +424,7 @@ The following parameters are available in the `sonarqube::plugin` defined type:

##### <a name="-sonarqube--plugin--artifactid"></a>`artifactid`

Data type: `String`
Data type: `String[1]`

Namevar. Specifies the name of the plugin.

Expand All @@ -441,7 +441,7 @@ Default value: `present`

##### <a name="-sonarqube--plugin--ghid"></a>`ghid`

Data type: `Optional[String]`
Data type: `Optional[String[1]]`

Specifies a combination of a GitHub username and project name,
for example `myuser/sonar-exampleplugin`. This is used to generate
Expand All @@ -451,7 +451,7 @@ Default value: `undef`

##### <a name="-sonarqube--plugin--groupid"></a>`groupid`

Data type: `String`
Data type: `String[1]`

Specifies the groupid to use with maven.

Expand All @@ -467,7 +467,7 @@ Default value: `false`

##### <a name="-sonarqube--plugin--url"></a>`url`

Data type: `Optional[String]`
Data type: `Optional[String[1]]`

A direct download URL that points to the .jar file for the specified plugin.
The filename must match the values of `$name` and `$version`, otherwise the
Expand All @@ -477,7 +477,7 @@ Default value: `undef`

##### <a name="-sonarqube--plugin--version"></a>`version`

Data type: `String`
Data type: `String[1]`

Specifies the version of the plugin. This is also required to find
and purge old plugin versions.
Expand Down
2 changes: 1 addition & 1 deletion metadata.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "markt-sonarqube",
"version": "5.3.0",
"version": "6.0.0",
"author": "markt.de",
"summary": "SonarQube installation and configuration",
"license": "Apache-2.0",
Expand Down

0 comments on commit f1d7409

Please sign in to comment.