General

The Karaka build system is a collection of scripts to create builds. Builds that can get created are:

• Public release builds
• Public developer release builds

On top of the release builds the build system can also perform automated code inspections. This allows to run all tests and inspections without interaction and generates a report for developers at the end.

The last feature is the backend and documentation generation based on the DocBlock documentation.

Setup

• Clone the repository somewhere save
• Check out the install.sh file and/or run it
• Modify the config.sh file to your needs
• Run buildProject.sh

Dependencies

The build system will take care of most requirements, the following tools and commands have to be available on the system.

software-properties-common npm git php8.1 php8.1-dev php8.1-cli php8.1-common php8.1-mysql php8.1-pgsql php8.1-xdebug php8.1-opcache php8.1-pdo php8.1-sqlite php8.1-mbstring php8.1-curl php8.1-imap php8.1-bcmath php8.1-zip php8.1-dom php8.1-xml php8.1-phar php8.1-gd php-pear apache2 mysql-server postgresql postgresql-contrib vsftpd tesseract-ocr wget curl grep xarg sed composer

Inspections

The following inspections are performed:

• Linting
• Security
• Unit tests
• Metrics (loc, dependencies)
• Code quality (crap, code coverage, code style)

In order to perform these inspections the build system relies on third party tools as well as custom scripts.