{"id":28388453,"url":"https://github.com/nucleos/relazy","last_synced_at":"2026-02-11T10:01:43.263Z","repository":{"id":174462742,"uuid":"652281229","full_name":"nucleos/relazy","owner":"nucleos","description":"⚙️ Tool for lazy people to create new git releases","archived":false,"fork":false,"pushed_at":"2026-01-11T20:58:47.000Z","size":170,"stargazers_count":1,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"0.4.x","last_synced_at":"2026-01-12T00:17:14.112Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://nucleos.rocks","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nucleos.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"core23","open_collective":"core23","ko_fi":"core23","custom":"https://donate.core23.de"}},"created_at":"2023-06-11T16:51:48.000Z","updated_at":"2025-10-12T19:07:41.000Z","dependencies_parsed_at":null,"dependency_job_id":"34d0ebb3-40b2-48f8-9fe0-defbb99ee781","html_url":"https://github.com/nucleos/relazy","commit_stats":null,"previous_names":["nucleos/relazy"],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/nucleos/relazy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nucleos%2Frelazy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nucleos%2Frelazy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nucleos%2Frelazy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nucleos%2Frelazy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nucleos","download_url":"https://codeload.github.com/nucleos/relazy/tar.gz/refs/heads/0.4.x","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nucleos%2Frelazy/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29331594,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-11T06:13:03.264Z","status":"ssl_error","status_checked_at":"2026-02-11T06:12:55.843Z","response_time":97,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-05-30T21:39:04.683Z","updated_at":"2026-02-11T10:01:43.245Z","avatar_url":"https://github.com/nucleos.png","language":"PHP","funding_links":["https://github.com/sponsors/core23","https://opencollective.com/core23","https://ko-fi.com/core23","https://donate.core23.de"],"categories":[],"sub_categories":[],"readme":"relazy\n======\n\n[![Latest Stable Version](https://poser.pugx.org/nucleos/relazy/v/stable)](https://packagist.org/packages/nucleos/relazy)\n[![Latest Unstable Version](https://poser.pugx.org/nucleos/relazy/v/unstable)](https://packagist.org/packages/nucleos/relazy)\n[![License](https://poser.pugx.org/nucleos/relazy/license)](LICENSE.md)\n\n[![Total Downloads](https://poser.pugx.org/nucleos/relazy/downloads)](https://packagist.org/packages/nucleos/relazy)\n[![Monthly Downloads](https://poser.pugx.org/nucleos/relazy/d/monthly)](https://packagist.org/packages/nucleos/relazy)\n[![Daily Downloads](https://poser.pugx.org/nucleos/relazy/d/daily)](https://packagist.org/packages/nucleos/relazy)\n\n[![Continuous Integration](https://github.com/nucleos/relazy/actions/workflows/continuous-integration.yml/badge.svg?event=push)](https://github.com/nucleos/relazy/actions?query=workflow%3A\"Continuous+Integration\"+event%3Apush)\n[![Code Coverage](https://codecov.io/gh/nucleos/relazy/graph/badge.svg)](https://codecov.io/gh/nucleos/relazy)\n\nRelazy is a handy tool to help releasing new versions of your software. You can define the type\nof version generator you want to use (e.g. semantic versioning), where you want to store\nthe version (e.g. in a changelog file or as a VCS tag) and a list of actions that should be\nexecuted before or after the release of a new version.\n\nThis project was originally inspired by the [RMT](https://github.com/liip/RMT) project, but with some major refactoring\nand more modern approach (e.g. PHP config with autocompletion).\n\nInstallation\n------------\n\n### Option 1: As a development dependency of your project\n\nIn order to use relazy in your project you should use [Composer](https://getcomposer.org/) to install it\nas a dev-dependency. Just go to your project's root directory and execute:\n\n```\ncomposer require --dev nucleos/relazy\n```\n\nThen you must need to create a `.relazy.php` config file to run the `relazy` executable script in your project's\nroot folder.\n\n```\n./relazy\n```\n\nOnce there, your best option is to pick one of the [configuration examples](#configuration-examples) below\nand adapt it to your needs.\n\n### Option 2: As a global Composer installation\n\nYou can add relazy to your global `composer.json` and have it available globally for all your projects. Therefor\njust run the following command:\n\n```\ncomposer global require nucleos/relazy\n```\n\nMake sure you have `~/.composer/vendor/bin/` in your $PATH.\n\n### Option 3: As a Phar file\n\nRelazy can be installed through [phar-composer](https://github.com/clue/phar-composer/), which needs to\nbe [installed](https://github.com/clue/phar-composer/#install) therefor. This useful tool allows you to create runnable\nPhar files from Composer packages.\n\nIf you have phar-composer installed, you can run:\n\n```\nphar-composer install nucleos/relazy\n```\n\nand have phar-composer build and install the Phar file to your `$PATH`, which then allows you to run it simply as `relazy`\nfrom the command line, or you can run\n\n```\nphar-composer build nucleos/relazy\n```\n\nand copy the resulting Phar file manually to where you need it. Either make the Phar file executable\nvia `chmod +x relazy.phar` and execute it directly `./relazy.phar` or run it by invoking it through PHP\nvia `php relazy.phar`.\n\nFor the usage substitute relazy with whatever variant you have decided to use.\n\nUsage\n-----\nUsing relazy is very straightforward, just run the command:\n\n```\n./relazy release\n```\n\nRelazy will then execute the following tasks:\n\n1. Execute the startup actions\n2. Ask the user to answer potentials questions\n3. Execute the pre-release actions\n4. Release\n    * Generate a new version number\n    * Persist the new version number\n5. Execute the post-release actions\n\nHere is an example output:\n\n### Additional commands\n\nThe `release` command provides the main behavior of the tool, additional some extra commands are available:\n\n* `current` will show your project current version number (alias version)\n* `changes` display the changes that will be incorporated in the next release\n\nConfiguration\n-------------\n\nAll relazy configurations have to be done in `.relazy.php`. The file is divided in the following elements:\n\n* `vcs`: The type of VCS you are using, can be `Git` or `Noop`\n* `startupActions`: A list `[]` of actions that will be executed just after startup without user interaction\n* `preReleaseActions`: A list `[]` of actions that will be executed before the release process\n* `versionGenerator`: The generator to use to create a new version (mandatory)\n* `versionPersister`: The persister to use to store the versions (mandatory)\n* `postReleaseActions`: A list `[]` of actions that will be executed after the release\n\nAll entries of this config work the same. You have to specify the class you want to handle the action. Example:\n\n```php\nuse Nucleos\\Relazy\\Changelog\\Formatter\\SemanticFormatter;\nuse Nucleos\\Relazy\\Config\\RelazyConfig;\nuse Nucleos\\Relazy\\Version\\Generator\\SimpleGenerator;\nuse Nucleos\\Relazy\\Version\\Persister\\TagPersister;\nuse Nucleos\\Relazy\\VersionControl\\Git;\n\nreturn (new RelazyConfig(new Git()))\n    -\u003eversionGenerator(new SimpleGenerator())\n    -\u003eversionPersister(new TagPersister(tagPrefix: 'v_'))\n    -\u003eformatter(new SemanticFormatter())\n    // ...\n;\n```\n\nExtend it\n---------\n\nRelazy is providing some existing actions, generators, and persisters. If needed you can add your own by creating a PHP\nscript in your project, and referencing it in the configuration:\n\n```php\nuse Nucleos\\Relazy\\Config\\RelazyConfig;\nuse Nucleos\\Relazy\\VersionControl\\Git;\n\nreturn (new RelazyConfig(new Git()))\n    -\u003eversionGenerator(new \\Acme\\CustomGenerator())\n    // ...\n;\n```\n\nConfiguration examples\n----------------------\nMost of the time, it will be easier for you to pick up an example below and adapt it to your needs.\n\n### No VCS, changelog updater only\n\n```php\nuse Nucleos\\Relazy\\Changelog\\Formatter\\SemanticFormatter;\nuse Nucleos\\Relazy\\Config\\RelazyConfig;\nuse Nucleos\\Relazy\\Version\\Generator\\SimpleGenerator;\nuse Nucleos\\Relazy\\Version\\Persister\\ChangelogPersister;\nuse Nucleos\\Relazy\\VersionControl\\Noop;\n\nreturn (new RelazyConfig())\n    -\u003eversionGenerator(new SimpleGenerator())\n    -\u003eversionPersister(new ChangelogPersister())\n    -\u003eformatter(new SemanticFormatter())\n    // ...\n;\n```\n\n### Using Git tags, simple versioning and startup actions\n\n```php\nnew Nucleos\\Relazy\\Action\\VersionControl\\CheckWorkingCopyAction;\nnew Nucleos\\Relazy\\Action\\VersionControl\\LastChangesAction;\nuse Nucleos\\Relazy\\Changelog\\Formatter\\SemanticFormatter;\nuse Nucleos\\Relazy\\Config\\RelazyConfig;\nuse Nucleos\\Relazy\\Version\\Generator\\SimpleGenerator;\nuse Nucleos\\Relazy\\Version\\Persister\\ChangelogPersister;\nuse Nucleos\\Relazy\\VersionControl\\Git;\n\nreturn (new RelazyConfig(new Git()))\n    -\u003eversionGenerator(new SimpleGenerator())\n    -\u003eversionPersister(new ChangelogPersister())\n    -\u003eformatter(new SemanticFormatter())\n    -\u003estartupActions([\n        new CheckWorkingCopyAction(),\n        new DisplayLastChanges(),\n    ])\n;\n```\n\n### Using Git tags, simple versioning and startup actions\n\n```php\nuse Nucleos\\Relazy\\Action\\Composer\\ValidateAction;\nuse Nucleos\\Relazy\\Action\\Composer\\StabilityCheckAction;\nuse Nucleos\\Relazy\\Action\\Composer\\DependencyStabilityCheckAction;\nuse Nucleos\\Relazy\\Changelog\\Formatter\\SemanticFormatter;\nuse Nucleos\\Relazy\\Config\\RelazyConfig;\nuse Nucleos\\Relazy\\Version\\Generator\\SimpleGenerator;\nuse Nucleos\\Relazy\\Version\\Persister\\TagPersister;\nuse Nucleos\\Relazy\\VersionControl\\Git;\n\nreturn (new RelazyConfig(new Git(signCommit: true, signTag: true)))\n    -\u003eversionGenerator(new SimpleGenerator())\n    -\u003eversionPersister(new TagPersister())\n    -\u003estartupActions([\n        new ValidateAction(),\n        new StabilityCheckAction(),\n        new DependencyStabilityCheckAction(allowList: [\n            'symfony/console',\n            'phpunit/phpunit' =\u003e 'require-dev',\n        ]),\n    ])\n;\n```\n\n### Using Git tags, simple versioning and startup actions, and gpg sign commit and tags\n\n```php\nnew Nucleos\\Relazy\\Action\\VersionControl\\CheckWorkingCopyAction;\nnew Nucleos\\Relazy\\Action\\VersionControl\\LastChangesAction;\nuse Nucleos\\Relazy\\Changelog\\Formatter\\SemanticFormatter;\nuse Nucleos\\Relazy\\Config\\RelazyConfig;\nuse Nucleos\\Relazy\\Version\\Generator\\SimpleGenerator;\nuse Nucleos\\Relazy\\Version\\Persister\\ChangelogPersister;\nuse Nucleos\\Relazy\\VersionControl\\Git;\n\nreturn (new RelazyConfig(new Git(signCommit: true, signTag: true)))\n    -\u003eversionGenerator(new SimpleGenerator())\n    -\u003eversionPersister(new ChangelogPersister())\n    -\u003estartupActions([\n        new CheckWorkingCopyAction(),\n        new DisplayLastChanges(),\n    ])\n;\n```\n\n### Using Git tags with prefix, semantic versioning, updating two files and pushing automatically\n\n```php\nuse Nucleos\\Relazy\\Action\\Filesystem\\FilesUpdateAction;\nuse Nucleos\\Relazy\\Action\\VersionControl\\PublishAction;\nuse Nucleos\\Relazy\\Config\\RelazyConfig;\nuse Nucleos\\Relazy\\Version\\Generator\\SemanticGenerator;\nuse Nucleos\\Relazy\\Version\\Persister\\TagPersister;\nuse Nucleos\\Relazy\\VersionControl\\Git;\n\nreturn (new RelazyConfig(new Git(signCommit: true, signTag: true)))\n    -\u003eversionGenerator(new SemanticGenerator())\n    -\u003eversionPersister(new TagPersister(tagPrefix: 'v_'))\n    -\u003epreReleaseActions([\n        new FilesUpdateAction(files: [\n            'config.yml' =\u003e '%version%',\n            'app.ini' =\u003e 'dynamic-version: %version%'\n        ]),\n    ])\n    -\u003epostReleaseActions([\n        new PublishAction(),\n    ])\n;\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnucleos%2Frelazy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnucleos%2Frelazy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnucleos%2Frelazy/lists"}