Post-pull hook

[cmmata]

Hello,

I would like to have a post-pull hook in my project, so every time I execute a git pull it could clear the local cache, execute other developers database migrations, or so. Do I make a PR? I think it should be more or less as #22.

[sebastianfeldmann]

I love the idea. Since CaptainHook 4.0 it got a little bit more complicated to add new hook events.
You have to add 2 classes and change some unit tests to make it work.
I took the liberty to do it :)

Are you doing it for a specific framework?
I would love to add repositories like captainhook/hooks-for-symfony, captainhook/hooks-for-magento, captainhook/hooks-for-laravel or any other framework where this kind of actions would make sense.

Would you consider contributing to one of such repositories?

[sebastianfeldmann]

I've just released version 4.0.1 including the new post-merge hook ;)

[sebastianfeldmann]

@heiglandreas maybe you or one of your colleagues is able to help with captainhook/hooks-magento

[cmmata]

That was fast! Thank you :) I'll test it right now.

I'm planning to use it in several Symfony 3.4 / 4.X projects, so if you create a hooks-for-symfony repo or something like that, I'll try to contribute with some typical / officially recommended hooks.

[heiglandreas]

Sure (as I'm doing magento ATM anyway). I could actually think of some stuff using the magento-cli like flushing caches etc.

Though I believe that due to different setups the mileage might vary in different projects. So I'd rather see them as a collection of framework specific hooks that then still need to be added manually to the config. Or am I missing something?

[sebastianfeldmann]

No that's exactly what I was thinking of!
Provide a list of hooks that you can add to you captainhook.json file in a way that fit your needs.

[cmmata]

So it will be only a captainhook.json with some typical hooks to copy and paste to your own files? Okay, I'll be configuring our projects and then send a PR with the file.

[sebastianfeldmann]

The actual hook implementations that are specific to those frameworks should be in the "framework repositories" as well.

So for example if you want to trigger some Laravel artisan commands, the hook implementations triggering this commands should be in the captainhook/hooks-laravel repository.

So if people require captainhook/hooks-laravel they can use those hooks in their captainhook.json

e.g.
composer.json

"require-dev": {
    "captainhook/hooks-laravel": "^4"
  },

captainhook.json

"post-merge": {
        "enabled": true,
        "actions": [
            {
                "action": "\\CaptainHook\\HooksLaravel\\Hook\\ClearCache",
                "options": {}
            }
        ]
    }

Or for any other framework we are supporting ;)

So the class \CaptainHook\HooksLaravel\Hook\ClearCache should be implemented in the captainhook/hooks-laravel repository

Since Laravel and Magento support cli commands I'm not sure how useful such kind of framework repositories would be. But I think to abstract those commands away or even provide the possibility to add options to a hook and simplify the config integration could justify those framework repositories.

[cmmata]

I think there's an error.. If I execute this

  ➜ .git/hooks/post-merge 

The response is

  execute hook: pre-push

Looks like pre-push hook is executed instead of post-merge. It's because of this line https://github.com/CaptainHookPhp/captainhook/blob/a31842ddd0d0889e1b2989a2313aa74011430f58/src/Runner/Hook/PostMerge.php#L30

If I change this to Hooks::POST_MERGE, then post-merge hook is executed, but doesn't seem to execute the configured hooks and returns an error:

No arguments expected, got "0".

If I execute .git/hooks/post-merge directly, it works as expected. I see it's because of the git hook itself

The hook takes a single parameter, a status flag specifying whether or not the merge being done was a squash merge.

[sebastianfeldmann]

Oh man, epic copy paste fail incoming.
Should have executed this even once for real #sorry #fail #shame

Will release a fix ASAP

[sebastianfeldmann]

Fixed in version 4.0.2

[cmmata]

I tried to resolve it by myself, but I made the change to App\Runner\Hook\PostMerge instead of App\Console\Command\Hook\PostMerge. I didn't understand why it wasn't running.. Thanks for the fix! Now it's working. I'll be playing with several commands and post a json to the hooks-symfony repo.

[sebastianfeldmann]

The secret is that the Symfony\Console\Commands require you to specify all your arguments.
After doing so https://github.com/CaptainHookPhp/captainhook/blob/master/src/Console/Command/Hook/PostMerge.php#L41 it works like a charm

I made the decision to explicitly fail and force to create a separate command for each hook to make the original hook arguments like isSquashMerge available for every CaptainHook\Action