update_code in sub-directory of release_path

[stephan-strate]

I would like to be able to checkout the repositories code to a sub-directory of the release_path.

My goal is to create a zero-downtime recipe for Grav. The flat-file cms Grav is a little bit different to most other frameworks. The repository will only contain the sub-directory user/ with custom plugins, themes, configuration and so on (see Folder Structure). My idea is to use composer create-project (see Installation) in the release_path first and then clone the content into the sub-directory user/.

Proposal:
Create update_code_path variable, which defaults to release_path, but also makes it configurable for special use-cases.

What do you think?

[Schrank]

I tried that with shopware to only have it in a subdir in git and it didn’t work well. You need to change everything™️. All the build, composer install, etc. It sucked so hard, I abandoned the idea.
And now I think it doesn’t makes sense as a generic solution. It adds a lot of complexity for a small edge case very few users have.

[stephan-strate]

Hmm, I don't see the problem here. Having it configurable doesn't hurt right? Because in this case the composer and build stuff needs to stick to the release_path. Just the content needs to be in a sub-directory.

How would you solve the update/deployment process of such frameworks? I'm not really into shopware, so I don't know what the requirements are there.

[antonmedv]

Right now you can check out subdirectories easily https://deployer.org/docs/7.x/recipe/deploy/update_code#sub_directory

[stephan-strate]

This works if you want to checkout a sub-directory of the git repository. I want to checkout the git repository inside a sub-directory in release_path.

Or we could make use of the --prefix option of this git archive command.

[Sogl]

@stephan-strate Did you manage to make a recipe for Grav?

[stephan-strate]

Situation 2. can not be implemented with deployer right now.
Specific grav versions can be installed using the .dependencies file and using bin/grav install, which is already covered in my recipe.

All other things are kind of not wanted by deployer, I guess.

[Sogl]

In my recipe user folder in git works fine, see my code.

Ok, you can install specific version. But how to get them all in console from local (dev) before install? Like this:

Grav 1.7.34
Admin 1.10.3
Breadcrumbs 1.5

So you can then put it into bin/gpm install <currently installed list>

Also you can't generate .dependencies from console, all by hands. Maybe it support versions, I don't know.

[antonmedv]

Can’t tell what is better for grav. I need to try to install and deploy it on my own to understand.

[stephan-strate]

Yeah, I know it works. But its fully custom and not using deployer recipes at all.

I do not know what you mean with generating from console. You can use bin/grav install locally as well. You could even use deployer to deploy it locally.

It gets a little off topic at this point. You are listing things that are either not supported by grav or deployer. Thats unfortunate, I agree, but will not bring us further with the recipe.

[Sogl]

Just wanted to share...

Today I created two tasks to install Grav CMS from zip-file (.git contains /user folder in my case). It has some hacks for cloning repo into non-empty folder with already installed plugins. In this case I don't use Deployer bare repo at all.

desc('Download Grav + Admin zip');
task('grav:download_zip', function () {
    // get by url
    run('wget -O {{release_path}}/grav_latest.zip {{grav_zip}}');
    // unzip it in same directory
    run('unzip {{release_path}}/grav_latest.zip -d {{release_path}}');
    // move all grav-admin files (+ dotfiles dotfolders) 
    run('mv {{release_path}}/grav-admin/* {{release_path}}/grav-admin/.[!.]*  {{release_path}}');
    // remove zip and extracted folder
    run('rm -r {{release_path}}/grav_latest.zip {{release_path}}/grav-admin');
    // delete all in user except plugins
    run('find {{release_path}}/user -mindepth 1 -maxdepth 1 -name plugins -prune -o -exec rm -rf {} \;');
});

desc ('Code update');
task('my:git', function () {
    cd('{{release_path}}/user');
    $git = get('bin/git');
    $repository = get('repository');
    run("$git init");
    run("$git remote add origin $repository");
    run("$git fetch");
    run("$git checkout -t origin/master -f");
    // install submodules (I have one with learn4 theme)
    run("$git submodule update --init");
});

The deployment has become a little faster to work.
And my idea about zip-installation improvement: getgrav/grav#3644