Add a command to remove a deploy hook from the list of deployed hooks in the site State

[MurzNN]

Is your feature request related to a problem? Please describe.
We have the deploy:hook feature that very is cool and better than hook updates.

But for local development very often we want to "uninstall" the deployed hook to try to deploy it again with some fixes.

For the hook_update we can easily just revert the installed version number of the module to the previous one, like this:

drush ev "drupal_set_installed_schema_version('my_module', 10123)"

But we have no option to do the same for the deploy hook.

Describe the solution you'd like
Provide a new command to remove the hook from the list of installed hooks, something like:

drush deploy:hook-remove hook_name

In this command we have to read the deploy_hook.existing_updates value from the site State, and remove the required hook from the list.

Describe alternatives you've considered
Instead of a separate command to unmark the hook_deploy as deployed, maybe we can introduce a way to force redeploy the specific hook_deploy by it's name, even if it is already deployed.

Additional context
Also, would be great to have the ability to list all currently deployed hooks.

And maybe provide a direct command to revert the module schema version too, instead of doing this using drush ev?

[mfrieling]

I've created this hook for my current project. At the moment I'm too busy but as soon as I find some time I'm willing to share it.

[harivansh0]

Hi @MurzNN

Proposed Solution

1. Remove a Deployed Hook

   • Command: drush deploy:hook-remove <hook_name>
   • Functionality: Reads deploy_hook.existing_updates from Drupal's State, removes the specified hook, and updates the state.

2. List Deployed Hooks

   • Command: drush deploy:hook-list
   • Functionality: Displays all hooks stored in deploy_hook.existing_updates.
   • Table column: Module, hook, description

3. Force Redeploy a Hook (Alternative)

   • Command: drush deploy:hook-redeploy <hook_name>
   • Functionality: Forces a specific hook_deploy to run again, even if marked as deployed, by temporarily removing it from deploy_hook.existing_updates or bypassing the check.

4. Set Module Schema Version

   • Command: drush module:schema-set <module> <version>
   • Functionality: Sets the schema version for a module, replacing the drush ev workaround.

Let me know, If I can start working on the solution

[MurzNN]

Thank you for the proposal, looks good! About deploy:hook-remove - the "remove" name is not clear, because we can't remove that is already deployed (I mean changes the hook already made), so maybe sometnig like "hook-list-remove" or "hook-unmark-as-deployed"?

[harivansh0]

Hi @MurzNN

Better alternative might be something like sort and concise:

deploy:mark-undone – highlights that we’re updating the state to say the hook hasn't been deployed.

deploy:unmark – concise and consistent with Drush naming patterns.

deploy:hook-unset – reflects the idea of unsetting the deployed status.

deploy:hook-reset – if the intention is to make the hook re-runnable.

[MurzNN]

deploy:hook-unset looks the best to me

[harivansh0]

Hi @MurzNN, thank you for the feedback.
I'll start working on the feature over the weekend.

[harivansh0]

Hi @MurzNN could you please review MR : #6280

[MurzNN]

I'll start working on the feature over the weekend.

Seems there was a long weekend! ;) Reviewed - good job, actually! Put only one comment, and the rest is good, thank you!

[harivansh0]

I'll start working on the feature over the weekend.

Seems there was a long weekend! ;) Reviewed - good job, actually! Put only one comment, and the rest is good, thank you!

Yes, I had some personal work.