Add an option to build magento artifact from the repository

[guvra]

• Bug fix #…?
• New feature?
• BC breaks?
• Tests added?
• Docs added?

Currently, the Magento 2 recipe only allows to build the artifact file from the current working directory.

This works perfectly fine when building the artifact on a platform dedicated to deployments (e.g. gitlab CI), but it makes it nearly impossible to deploy from a local environment for the following reasons:

• A dev environment runs in developer mode.
• The vendor directory contains dev packages
• There is a possibility that the current working directory contains uncommitted files.

The goal of this PR is to add an option that works around this limitation, by cloning the project repository in a temporary folder, and creating the artifact file from this repository.

Example usage:

dep artifact:build localhost --option build_from_repo=1

<?php

namespace Deployer;

require 'recipe/magento2.php';

localhost()
    ->set('local', true);

host('prod')
    ->setHostname('myprod')
    ->setRemoteUser('www')
    ->setDeployPath('/var/www/html');

set('repository', 'git@xxxxxxxxxxxxxxxx.git');

If no repository was specified (repository option), an error is displayed.

Advantages:

• No BC changes, it's just a new option.
• Very few changes to the current code of the recipe.
• Allows to easily deploy Magento projects from a local environment (more user friendly than having to create a build environment or setting up automatic deployment on a github/gitlab CI).

[guvra]

docgen workflow was failing, I amended the commit to update the documentation.

[Schrank]

@schmengler @peterjaap I'm not totally sure I understand what happens here. Can I have a second opinion? From my point of view, I'm happy to merge it.

[peterjaap]

@Schrank I have 4 MR's to look at by the other Fabian :P @schmengler I'll try to get around to it tomorrow!

[schmengler]

The feature looks fine, but documentation is missing

[guvra]

I added better documentation about the feature:

• A comment explain how to use build_from_repo
• A comment explains that repository must be overridden if build_from_repo is set to true.

[schmengler]

@guvra question: How would one specify which branch should be built?
I imagine something like dep artifact:build localhost --option build_from_repo=1 --option build_from_branch=release/1.0 would be useful

[guvra]

I don't know if I should add a comment about recommending to set the target option (by default it uses HEAD, in most cases you need to deploy a tag or a specific branch instead).

[schmengler]

I don't know if I should add a comment about recommending to set the target option (by default it uses HEAD, in most cases you need to deploy a tag or a specific branch instead).

posted at the same time :D yes, please do! As you see I was confused

[guvra]

@schmengler I just thought of another way of doing it:

• If repository is set, then the artifact is built from a clean copy of the repository with the specified target (HEAD by default, but can be overridden with --branch, --tag or --revision).
• Otherwise, it's built from the current working directory (current behavior)

With this logic, we don't need build_from_repo anymore.

It's more simple, but maybe also more confusing/dangerous? Can be considered as a compatibility break too.

[schmengler]

tbh, I wasn't aware of these CLI arguments, but that seems to be exactly the way they are intended to be used, like in the update_code recipe:

deployer/recipe/deploy/update_code.php

Lines 73 to 74 in fe38743

	$repository = get('repository');
	$target = get('target');

Since the magento recipe currently does not use the repository or target variables I don't see a real backwards compatibility issue

[peterjaap]

LGTM! @antonmedv merge at will