Skip to content

Commit a784a42

Browse files
committed
docs: update BUILDING.md and INDEX.md to reflect toolchain changes
BUILDING.md: - Add --no-scripts to manual 'composer install' command (prevents kcode init from running during install before binary exists) - Update Version Bumping section: Makefile now resolves VERSION via 'git describe --tags' first, falling back to box.json → 'dev' INDEX.md: - Add Code Quality workflow to Quick Navigation (code-quality.yml: security + phpstan + cs-fixer via kcode) - Update CI workflow description: 'Tests + PHAR build on push/PR'
1 parent 71d1c05 commit a784a42

2 files changed

Lines changed: 5 additions & 4 deletions

File tree

docs/BUILDING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,8 +65,8 @@ make self-test # Run against this project
6565
### Manual Build
6666

6767
```bash
68-
# 1. Install dependencies (with dev for quality tools inside PHAR)
69-
composer install --no-interaction --prefer-dist --optimize-autoloader
68+
# 1. Install dependencies (with dev quality tools are bundled in the PHAR)
69+
composer install --no-interaction --prefer-dist --optimize-autoloader --no-scripts
7070

7171
# 2. Compile PHAR
7272
php -d phar.readonly=0 box compile --config=box.json
@@ -221,4 +221,4 @@ The version is stored in two places — keep them in sync:
221221
1. `src/Core/Devkit.php``private const string VERSION = '1.0.0';`
222222
2. `box.json``metadata.version`
223223

224-
The Makefile reads the version from `box.json` for build output messaging.
224+
The Makefile resolves the version via `git describe --tags --abbrev=0` first, falling back to `box.json` metadata, then `'dev'`. Always tag releases with `git tag vX.Y.Z` before running `make release`.

docs/INDEX.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,6 @@
2727
- [composer.json](../composer.json) — Package definition
2828
- [box.json](../box.json) — PHAR compilation configuration
2929
- [Makefile](../Makefile) — Build automation targets
30-
- [CI workflow](../.github/workflows/ci.yml) — Quality checks on push/PR
30+
- [CI workflow](../.github/workflows/ci.yml) — Tests + PHAR build on push/PR
31+
- [Code Quality workflow](../.github/workflows/code-quality.yml) — Security, PHPStan, CS-Fixer via kcode
3132
- [Release workflow](../.github/workflows/release.yml) — PHAR build on tag push

0 commit comments

Comments
 (0)