Skip to main content
Version: 8.x

Update Code Recipe

require 'recipe/deploy/update_code.php';

Source

Configuration​

branch​

Source

Determines which branch to deploy. Can be overridden with CLI option --branch. If not specified, will get current git HEAD branch as default branch to deploy.

Default value
'HEAD'

target​

Source

The deploy target: a branch, a tag or a revision.

Autogenerated

The value of this configuration is autogenerated on access.

update_code_strategy​

Source

Sets deploy:update_code strategy. Can be one of:

  • archive
  • clone (if you need the origin repository .git dir in your release_path)
Default value
'archive'

git_ssh_command​

Source

Sets environment variable GIT_SSH_COMMAND for git clone command. If StrictHostKeyChecking flag is set to accept-new then ssh will automatically add new host keys to the user known hosts files, but will not permit connections to hosts with changed host keys.

Default value
'ssh -o StrictHostKeyChecking=accept-new'

sub_directory​

Source

Specifies a sub directory within the repository to deploy. Works only when update_code_strategy is set to archive (default).

Example:

  • set value to src if you want to deploy the folder that lives at /src.
  • set value to src/api if you want to deploy the folder that lives at /src/api.

Note: do not use a leading /!

Default value
false

Tasks​

deploy:update_code​

Source

Updates code.

Update code at release_path on host.