 |
VOOZH | about |
|
VOOZH | about |
This page covers how the ai-commit PHAR artifact is built, how versions are tagged and released, and how CHANGELOG.md is maintained. It focuses on the build tooling (box.json), the release automation (monorepo-builder.php), and the GitHub Actions workflows that coordinate publication.
For information about the CI quality gates that run on every push (tests, linting, static analysis), see CI/CD Workflows. For the development environment setup needed before running these tools locally, see Development Environment Setup.
Release pipeline diagram
Sources: monorepo-builder.php41-54 .github/workflows/publish-phar.yml1-61 .github/workflows/update-changelog.yml1-30
The PHAR is produced by Humbug Box controlled by box.json at the repository root. Laravel Zero's app:build console command invokes Box internally.
box.json Settings| Field | Value | Effect |
|---|---|---|
chmod | "0755" | Makes the output PHAR directly executable |
directories | app, bootstrap, config, resources/lang, vendor | Directories bundled into the PHAR |
files | composer.json | Individual files added to the PHAR |
exclude-composer-files | false | Keeps Composer metadata inside the PHAR |
exclude-dev-files | false | Does not strip dev-only files |
compression | "GZ" | Applies GZip compression to the PHAR contents |
compactors | Php, Json | Strips whitespace/comments from PHP and JSON files |
Sources: box.json1-21
./ai-commit app:build ai-commit.phar --build-version=<version>
The app:build command is provided by Laravel Zero. It calls Box with box.json as configuration and writes output to builds/ai-commit.phar.
The header of the committed builds/ai-commit confirms the toolchain:
Generated by Humbug Box 3.16.0@adb282a.
Sources: builds/ai-commit1-8 .github/workflows/publish-phar.yml37-38
builds/ai-commit?builds/ai-commit is the PHAR without the .phar extension, committed directly to the main branch. It is the file users download or execute directly via ./builds/ai-commit. It is binary (GZ-compressed PHAR format) and tracked in version control.
After the CI build, the workflow copies builds/ai-commit.phar → builds/ai-commit and commits it:
cp builds/ai-commit.phar builds/ai-commit
Sources: .github/workflows/publish-phar.yml52-60 builds/ai-commit1-16
Releases are driven by symplify/monorepo-builder The release workers are registered in monorepo-builder.php and execute in order.
Release worker execution order
Sources: monorepo-builder.php41-54
| Worker class | Role |
|---|---|
TagVersionReleaseWorker | Creates a local git tag for the release version |
PushTagReleaseWorker | Pushes the tag to the remote repository |
UpdateChangelogViaGoReleaseWorker | Updates CHANGELOG.md using git-chglog (Go-based tool) |
CreateGithubReleaseReleaseWorker | Creates a GitHub Release via the GitHub API |
Workers listed as commented-out in monorepo-builder.php are disabled:
| Disabled worker | Why disabled |
|---|---|
UpdateReplaceReleaseWorker | Not a monorepo with split packages |
SetCurrentMutualDependenciesReleaseWorker | Single-package repo |
AddTagToChangelogReleaseWorker | Replaced by UpdateChangelogViaGoReleaseWorker |
UpdateChangelogViaNodeReleaseWorker | Alternative; Go tool is used instead |
UpdateChangelogViaPhpReleaseWorker | Alternative; Go tool is used instead |
SetNextMutualDependenciesReleaseWorker | Single-package repo |
UpdateBranchAliasReleaseWorker | Not configured |
PushNextDevReleaseWorker | Not used |
Sources: monorepo-builder.php41-54
The changelog is managed by two mechanisms that operate at different points in the release process.
git-chglog (Go tool) via UpdateChangelogViaGoReleaseWorkerConfiguration lives in .chglog/config.yml. The tool reads conventional commit messages and generates CHANGELOG.md using the template at .chglog/CHANGELOG.tpl.md.
Commit type filtering and grouping
| Commit type | Group title in CHANGELOG |
|---|---|
feat | ✨ Features |
fix | 🐞 Bug Fixes |
docs | 📖 Documents |
style | 🎨 Styles |
refactor | 💅 Code Refactorings |
perf | 🏎 Performance Improvements |
test | ✅ Tests |
build | 📦 Builds |
ci | 🤖 Continuous Integrations |
revert | ⏪️ Reverts |
The chore type is explicitly filtered out (commented in config).
Commit header pattern (from .chglog/config.yml):
^(\w*)(?:\(([\w\$\.\-\*\s]*)\))?:\s(.*)$
Maps to: Type, Scope, Subject.
Sources: .chglog/config.yml1-77 .chglog/CHANGELOG.tpl.md1-63
update-changelog.yml workflowThis workflow triggers on release: types: [released] (after a release is published on GitHub). It uses stefanzweifel/changelog-updater-action@v1 to inject the release notes from the GitHub Release body into CHANGELOG.md, then commits the result back to main.
Sources: .github/workflows/update-changelog.yml1-30
publish-phar.yml Workflow DetailTrigger: release: types: [created]
Runner: ubuntu-22.04
PHP version: 8.2
Step-by-step
Tag extraction: The workflow extracts the version number from GITHUB_REF by stripping the leading v prefix:
This tag is passed to --build-version so the PHAR reports the correct version at runtime.
Sources: .github/workflows/publish-phar.yml1-61
| Artifact | Path | Notes |
|---|---|---|
| PHAR with extension | builds/ai-commit.phar | Built during workflow, uploaded to GitHub Release |
| PHAR without extension | builds/ai-commit | Committed to main; used for self-invocation and direct download |
| Changelog | CHANGELOG.md | Updated by both git-chglog and the update-changelog workflow |
Sources: .github/workflows/publish-phar.yml43-60 builds/ai-commit1-8
Sources: box.json1-21 monorepo-builder.php1-57 .chglog/config.yml1-77 .github/workflows/publish-phar.yml1-61 .github/workflows/update-changelog.yml1-30
Refresh this wiki