andriichuk/releaser

Release automation script for Laravel projects

dev-main 2025-12-21 05:17 UTC

Requires

• php: >=8.1

MIT

• Serhii Andriichuk

• git
• laravel
• automation
• release

README

A small Bash-based release helper for PHP projects. It automates release branch creation, version updates, and post-release branch syncing using simple CLI arguments.

Requirements

• Bash
• Git
• PHP (local or containerized)

Installation

composer require andriichuk/releaser --dev

Usage

./vendor/bin/releaser \
  --php-cmd="./vendor/bin/sail php" \
  --composer-cmd="./vendor/bin/sail composer" \
  --git-remote-name=origin \
  --main-branch=main \
  --main-dev-branch=develop \
  --release-branch-prefix="release/" \
  --with-tests=true \
  --with-composer-audit=true \
  --config-file="./config/app.php" \
  --with-app-version-update=false
  --post-release-update-branches=develop,stage

Arguments

--php-cmd

Path to the PHP executable used for version updates.

Examples:

• Local PHP: --php-cmd="php"
• Docker container: --php-cmd="docker compose exec -T app php"
• Laravel Sail: --php-cmd="./vendor/bin/sail php"

--composer-cmd

--git-remote-name

Git remote name to push branches to.

Default: origin

--main-branch

Main production branch (e.g., main or master), default main.

--main-dev-branch

Primary development branch where new features are merged, default develop.

--release-branch-prefix

Prefix for release branches, default release/. This will produce branches like: release/1.0.0.

--with-app-version-update

Whether to update the application version during release. Values: true or false. Default: false.

--post-release-update-branches

Comma-separated list of branches to sync with the main development branch after a release (e.g., develop,stage). By default, the main development branch is used.