All notable changes to luisaveiro/localhost-sonarqube
will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Use Bashdrop forked version of ANSI Code Generator
- Prevent console loading from missing DotEnv.
- Typo for explain help command.
- DotEnv support.
- DotEnv example file.
DOTENV
&SONARQUBE_PORT
global constant.port
command to update SonarQube service port.
- SonarQube service host port to be configurable via DotEnv.
- Clean up
docs
command.
- Config file ordering.
- TL;DR section in Readme.
- Code formatting.
- Clean up doc-blocks.
- Unnecessary code for function parameters checking.
- SonarQube not running on Apple Silicon (M1/M2).
- Renamed Docker Compose files to follow compose specifications.
- Readme to adopt Compose V2 specifications.
- Refactor the explain commands.
CURRENT_DIR
toBIN_DIR
.- use Bash "is not empty" argument.
- Formatting.
list
commandprintf
formatting.- Typos in doc-blocks.
- ShellCheck Docker image tag.
- The lib dependencies array to be readonly.
- Typos in doc-blocks.
- The list command console output messages.
- Formatting.
- Corrected the naming convention for
help::display_usage
option parameters.
- Redundant code for publish command.
about
command to display a short information about Localhost SonarQube.analyse
alias command forscan
command.config
command to display Docker Compose config.docs
command to open Localhost SonarQube documentation in the browser.fund
command to display Localhost SonarQube funding information.list
command to list available SonarScanner properties files,restart
command to restart SonarQube Docker containers.start
alias command forup
commandstatus
command to display the status of SonarQube & SonarScanner containers.stop
alias command fordown
command.support
alias command forsupport
command.usage
command to display a list of all available commands.version
command to display Localhost SonarQube installed version.wiki
alias command fordocs
command.
- Refactor the Localhost SonarQube codebase.
- All functions of Localhost SonarQube codebase are in
lib
directory. - All functions of Localhost SonarQube codebase are namespaced.
- Moved global config constants into
config
directory. help
command displays help information for a command instead of list of all available commands.- Improved format of
error
,info
,notice
&warning
messages. - Use Blacksmith Engineers forked version of ANSI Code Generator
packages
directory to store third-party packages.
sonarqube
being sourced. Localhost SonarQube is executed in a new shell process.- The
scan
command could only scan one project at a time.
self-update
command output messages.
progressbar
package.docker::pull
command to update Docker images.git::checkout
function togit
package.notice
log output functions.messages
namespace for repeatable output messages- A status message of SonarQube containers after executing
down
&up
commands.
self-update
command updates SonarQube and SonarScanner Docker images.- SonarScanner container has a predefined name.
output
function supports--overwrite
argument.- Improved output messages.
- SonarScanner throwing an error if SonarQube is not running.
- Support Ukraine message to terminal and readme.
newline
function
output
function accepts new--newline
argument.- Improved format of output messages.
- ShellCheck for Visual Studio Code.
- Problematic code in the case of readonly (ShellCheck SC2155).
self-update
command git output to throwaway variable.git::fetch
function output to standard output and error.
git::fetch
function togit
package.
self-update
command.
- Scan command include cache volume for scanner files.
PROJECT_NAME
global constant.- Self update command.
- Self update section in readme.
- Scan command caches scanner files.
docker_compose::command
command accepts project name and set an alternate project name.docker::run
command accepts multiple volumes.- Info output prefix colour from white to blue.
- Prevent Docker Compose to prefix volume names with "docker_" during
docker-compose up
. - Prevent functions declaring variables from unwanted arguments.
directory_exists
filesystem function.- Help and Git package.
- Help command.
- Help section in readme.
PROJECT_DIR
global constant to be exportable.
- Improve formatting to be more in line with Google Shell Style Guide.
error
,info
,warning
,output
log output functions accept multiple arguments.
option
parameters differentiation for functions.
- ANSI Code Generator to improve CLI messages.
error
,info
,warning
log output functions.- Docker compose package
- Docker package
PROJECT_DIR
&TEMPLATE_DIR
global constants
- Shell scripts to use
error
,info
,warning
log output functions to improve CLI messages. - Change
sonarqube up
&sonarqube down
commands to use docker compose package. - Renamed
open_sonarqube_dashboard
function toopen_browser
. - Replaced
configuration_template_exists
&project_configuration_exists
withfile_exists
. - Change
sonarqube publish
&sonarqube scan
commands to usefile_exists
function. - Shell scripts to use docker package.
- Commands and functions shell script to follow package structure.
- Commands to follow better functional programming principles.
- Fixed
sonar.host.url
for SonarScanner template #5.
- Global
WHITE
&NC
constants from config. - Unused
up
&down
command scripts. run_docker_compose
function.publish_configuration
function.- Unused
docker
function script.
- Laravel SonarScanner template.
- Useful Tips section in readme.
- Test coverage & execution properties for default and laravel SonarScanner templates.
- Fixed
sonar.host.url
for default SonarScanner template.
- EditorConfig file.
- Shell scripts to adopt Google Shell Style Guide.
- Shell scripts based on ShellCheck syntax guidelines.
- Docker Compose YAML file.
- Default
sonar-project.properties
. - SonarQube shell script provides convenient CLI commands.