deployer/docs/recipe/deploy/update_code.md
Jan Henk Hazelaar 3953996a30
Add remote option to update_code_strategy to rename remote to repository (#3466)
* Add 'remote' option to 'update_code_strategy'

* Using archive and then add remote to speedup deployment

* Optimize remote option and add documentation

* Optimize code

* Update docs

* Combine clone and remote to remove duplicate code

* Removed  option and merge functionality into  option

* Generate docs

* Generate docs
2023-02-10 23:51:27 +01:00

2.3 KiB

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.

'HEAD'

target

Source

The deploy target: a branch, a tag or a revision. :::info 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)
'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.

'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/api.
  • set value to src/api if you want to deploy the folder that lives at /src/api.

Note: do not use a leading /!

false

Tasks

deploy:update_code

Source

Updates code.

Update code at release_path on host.