Not only Composer tools to build a Monorepo
Do you maintain a monorepo with more packages?
This package has few useful tools, that will make that easier.
Install
composer require symplify/monorepo-builder --devUsage
1. Are you New to Monorepo?
The best to lean-in fast is to read basic intro at blog post All You Always Wanted to Know About Monorepo. We also made a simple command to make that easy for you:
vendor/bin/monorepo-builder initAnd the basic setup is done!
2. Merge local composer.json to the Root One
Merges configured sections to the root composer.json, so you can only edit composer.json of particular packages and let script to synchronize it.
Sections that are needed for monorepo to work will be merged:
- 'require'
- 'require-dev'
- 'autoload'
- 'autoload-dev'
- 'repositories'
- 'extra'
To merge run:
vendor/bin/monorepo-builder mergeTypical location for packages is /packages. But what if you have different naming or extra /projects directory?
use Symplify\MonorepoBuilder\ComposerJsonManipulator\ValueObject\ComposerJsonSection;
use Symplify\MonorepoBuilder\Config\MBConfig;
use Symplify\MonorepoBuilder\ValueObject\Option;
return static function (MBConfig $mbConfig): void {
// where are the packages located?
$mbConfig->packageDirectories([
// default value
__DIR__ . '/packages',
// custom
__DIR__ . '/projects',
]);
// how to skip packages in loaded directories?
$mbConfig->packageDirectoriesExcludes([__DIR__ . '/packages/secret-package']);
// "merge" command related
// what extra parts to add after merge?
$mbConfig->dataToAppend([
ComposerJsonSection::AUTOLOAD_DEV => [
'psr-4' => [
'Symplify\Tests\\' => 'tests',
],
],
ComposerJsonSection::REQUIRE_DEV => [
'phpstan/phpstan' => '^0.12',
],
]);
$mbConfig->dataToRemove([
ComposerJsonSection::REQUIRE => [
// the line is removed by key, so version is irrelevant, thus *
'phpunit/phpunit' => '*',
],
ComposerJsonSection::REPOSITORIES => [
// this will remove all repositories
Option::REMOVE_COMPLETELY,
],
]);
};3. Bump Package Inter-dependencies
Let's say you release symplify/symplify 4.0 and you need package to depend on version ^4.0 for each other:
vendor/bin/monorepo-builder bump-interdependency "^4.0"4. Keep Synchronized Package Version
In synchronized monorepo, it's common to use same package version to prevent bugs and WTFs. So if one of your package uses symfony/console 3.4 and the other symfony/console 4.1, this will tell you:
vendor/bin/monorepo-builder validate5. Keep Package Alias Up-To-Date
You can see this even if there is already version 3.0 out:
{
"extra": {
"branch-alias": {
"dev-master": "2.0-dev"
}
}
}Not good. Get rid of this manual work and add this command to your release workflow:
vendor/bin/monorepo-builder package-aliasThis will add alias 3.1-dev to composer.json in each package.
If you prefer 3.1.x-dev over default 3.1-dev, you can configure it:
use Symplify\MonorepoBuilder\Config\MBConfig;
return static function (MBConfig $mbConfig): void {
// default: "<major>.<minor>-dev"
$mbConfig->packageAliasFormat('<major>.<minor>.x-dev');
};6. Split Directories to Git Repositories
Thanks to GitHub Actions, this was never simpler to set up. Use symplify/github-action-monorepo-split.
How to configure it? See our local setup at .github/workflows/split_monorepo.yaml
7. Release Flow
When a new version of your package is released, you have to do many manual steps:
- bump mutual dependencies,
- tag this version,
git pushwith tag,- change
CHANGELOG.mdtitle Unreleased tov<version> - Y-m-dformat - bump alias and mutual dependencies to next version alias
But what if you forget one or do it in wrong order? Everything will crash!
The release command will make you safe:
vendor/bin/monorepo-builder release v7.0And add the following release workers to your monorepo-builder.php:
use Symplify\MonorepoBuilder\Config\MBConfig;
use Symplify\MonorepoBuilder\Release\ReleaseWorker\AddTagToChangelogReleaseWorker;
use Symplify\MonorepoBuilder\Release\ReleaseWorker\PushNextDevReleaseWorker;
use Symplify\MonorepoBuilder\Release\ReleaseWorker\PushTagReleaseWorker;
use Symplify\MonorepoBuilder\Release\ReleaseWorker\SetCurrentMutualDependenciesReleaseWorker;
use Symplify\MonorepoBuilder\Release\ReleaseWorker\SetNextMutualDependenciesReleaseWorker;
use Symplify\MonorepoBuilder\Release\ReleaseWorker\TagVersionReleaseWorker;
use Symplify\MonorepoBuilder\Release\ReleaseWorker\UpdateBranchAliasReleaseWorker;
use Symplify\MonorepoBuilder\Release\ReleaseWorker\UpdateReplaceReleaseWorker;
return static function (MBConfig $mbConfig): void {
// release workers - in order to execute
$mbConfig->workers([
UpdateReplaceReleaseWorker::class,
SetCurrentMutualDependenciesReleaseWorker::class,
AddTagToChangelogReleaseWorker::class,
TagVersionReleaseWorker::class,
PushTagReleaseWorker::class,
SetNextMutualDependenciesReleaseWorker::class,
UpdateBranchAliasReleaseWorker::class,
PushNextDevReleaseWorker::class,
]);
};You can also include your own workers. Just add services that implements ReleaseWorkerInterface.
Are you afraid to tag and push? Use --dry-run to see only descriptions:
vendor/bin/monorepo-builder release 7.0 --dry-runDo you want to release next patch version, e.g. current v0.7.1 → next v0.7.2?
vendor/bin/monorepo-builder release patchYou can use minor and major too.