mirror of
https://github.com/Karaka-Management/Build.git
synced 2026-01-10 19:28:41 +00:00
36 lines
1.4 KiB
Markdown
Executable File
36 lines
1.4 KiB
Markdown
Executable File
# 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.2 php8.2-dev php8.2-cli php8.2-common php8.2-mysql php8.2-pgsql php8.2-xdebug php8.2-opcache php8.2-pdo php8.2-sqlite php8.2-mbstring php8.2-curl php8.2-imap php8.2-bcmath php8.2-zip php8.2-dom php8.2-xml php8.2-phar php8.2-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.
|