famoser/agnes

Creates & deploys releases safely to various environments.

v4.3.3 2024-11-17 10:10 UTC

README

Release and deploy safely.

Install with

composer require famoser/agnes --dev

Then run commands

php vendor/bin/agnes release v1.0 main`

commands

for details on the commands use the --help argument.
to easily remember the order of arguments observe that the target is always first.

config

By default, the file called agnes.yml in your project root is taken as configuration (use --config-file to change).

Additionally to the config file you can supply a config folder which contains:

  • additional .yml files which will all be merged with the main config file (handy separate policies & server config )
  • other files which are needed for the installation but not part of the repository (like .env.local files)

In the config files, you can use placeholders like %env(KEY) which are replaced by environment variables upon loading the config. You can define environment variables in a .env or .env.local file in your project root.

Full example config in sample.yml.

advanced config

if you have an SSH connection configured you can speed up command execution greatly by caching the connection in ~/.ssh/config:

Host *
  ControlPath /tmp/ssh-%r@%h:%p
  ControlMaster auto
  ControlPersist yes