README

简体中文 | ENGLISH

Note

A set of additional release workers for symplify/monorepo-builder.

Requirement

• PHP >= 8.2

Installation

composer require guanguans/monorepo-builder-worker --dev --ansi -v

Usage

Examples

• 🧐 Releases
• 🧐 CHANGELOG.md

In your monorepo-builder configuration register workers

use Guanguans\MonorepoBuilderWorker\ReleaseWorker\CreateGithubReleaseReleaseWorker;
use Guanguans\MonorepoBuilderWorker\ReleaseWorker\UpdateChangelogViaGoReleaseWorker;
use Guanguans\MonorepoBuilderWorker\Support\EnvironmentChecker;
use Symplify\MonorepoBuilder\Config\MBConfig;

return static function (MBConfig $mbConfig): void {
    $mbConfig->workers($workers = [
        UpdateChangelogViaGoReleaseWorker::class,
        CreateGithubReleaseReleaseWorker::class,
        // Other release workers...
    ]);

    EnvironmentChecker::checks($workers);
};

Run command

╰─ vendor/bin/monorepo-builder release patch --ansi -v                                                              ─╯

 ! [NOTE] Checking environment...                                                                                       


 ! [NOTE] Running process: git-chglog -v                                                                                

 ! [NOTE] Running process: gh auth status                                                                               

 ! [NOTE] Running process: gh release list --limit 1                                                                    

 ! [NOTE] Environment checked!                                                                                          


 ! [NOTE] Running process: git tag -l --sort=committerdate                                                              

1/4) Add local tag "2.0.1"
==========================

class: Symplify\MonorepoBuilder\Release\ReleaseWorker\TagVersionReleaseWorker

 ! [NOTE] Running process: git add . && git commit -m "prepare release" && git push origin "main"                       

 ! [NOTE] Running process: git tag 2.0.1                                                                                

2/4) Push "2.0.1" tag to remote repository
==========================================

class: Symplify\MonorepoBuilder\Release\ReleaseWorker\PushTagReleaseWorker

 ! [NOTE] Running process: git push --tags                                                                              

3/4) Update changelog "2.0.1 (2025-04-07)"
==========================================

class: Guanguans\MonorepoBuilderWorker\GoUpdateChangelogReleaseWorker

 ! [NOTE] Running process: git-chglog --output CHANGELOG.md                                                             

 ! [NOTE] Running process: git add CHANGELOG.md && git commit -m "chore(release): 2.0.1" --no-verify && git push        

 ! [NOTE] Running process: git-chglog 2.0.1                                                                             

4/4) Create github release "2.0.1"
==================================

class: Guanguans\MonorepoBuilderWorker\CreateGithubReleaseWorker

 ! [NOTE] Running process: gh release create 2.0.1 --notes <a name="2.0.1"></a>                                         
 !        ## [2.0.1] - 2025-04-07
 !        ### ✨ Features
 !        - **rector:** Add AddDocCommentsToDeclareRector functionality ([9d35c08](https://github.com/guanguans/monorepo-builder-worker/commit/9d35c08))
 !        
 !        ### 🐞 Bug Fixes
 !        - **EnvironmentChecker:** Improve namespace prefix handling ([7437c0e](https://github.com/guanguans/monorepo-builder-worker/commit/7437c0e))
 !        - **config:** Enable final flags in various methods ([d25cde1](https://github.com/guanguans/monorepo-builder-worker/commit/d25cde1))
 !        - **scripts:** Update Namespace Prefix Fix Method Reference ([aae90a1](https://github.com/guanguans/monorepo-builder-worker/commit/aae90a1))
 !        
 !        ### 💅 Code Refactorings
 !        - apply rector ([695b1c4](https://github.com/guanguans/monorepo-builder-worker/commit/695b1c4))
 !        - **CreateGithubReleaseReleaseWorker:** Simplify changelog retrieval ([032bb46](https://github.com/guanguans/monorepo-builder-worker/commit/032bb46))
 !        - **core:** Enhance configuration and class handling ([ffe041c](https://github.com/guanguans/monorepo-builder-worker/commit/ffe041c))
 !        - **helpers:** Optimize class loading logic in classes() function ([16a7ad1](https://github.com/guanguans/monorepo-builder-worker/commit/16a7ad1))
 !        
 !        ### ✅ Tests
 !        - Add initial test files and functionality ([2beb107](https://github.com/guanguans/monorepo-builder-worker/commit/2beb107))
 !        - **Helpers:** Add test for classes retrieval ([f965e62](https://github.com/guanguans/monorepo-builder-worker/commit/f965e62))
 !        
 !        ### 🤖 Continuous Integrations
 !        - **tests:** Check and fix namespace prefix in workflow ([f465092](https://github.com/guanguans/monorepo-builder-worker/commit/f465092))
 !        - **workflows:** Fix monorepo builder prefix command ([d449138](https://github.com/guanguans/monorepo-builder-worker/commit/d449138))
 !                                                                                                                      
 !                                                                                                                      
 !        [2.0.1]: https://github.com/guanguans/monorepo-builder-worker/compare/2.0.0...2.0.1                           

                                                                                                                        
 [OK] Version "2.0.1" is now released!                                                                                  
                                                                                                                        

Composer scripts

composer checks:required
composer php-cs-fixer:fix
composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• guanguans
• All Contributors

License

The MIT License (MIT). Please see License File for more information.