[8.x] Add new VendorTagPublished event
#36458
Conversation
| $this->publishItem($from, $to); | ||
|
|
||
| $published = true; | ||
| } | ||
|
|
||
| $this->laravel['events']->dispatch(new VendorTagPublished($tag, $pathsToPublish)); |
There was a problem hiding this comment.
There's a couple of concerns here: first of all it's unsure if anything is published at this point. As such it's better that this line is part of the else condition of the if statement below.
Secondly, the $pathsToPublish isn't necessarily all of the paths that were published (see the contents of publishItem).
There was a problem hiding this comment.
@ryangjchandler I answered this before reading your main PR comment, sorry.
There was a problem hiding this comment.
@driesvints No worries, wanted to get your opinion on it because the console output is actually a bit misleading.
An alternative solution might be only passing the $tag through to the event, technically speaking if you're listening for a particular tag, then you are 99% of the time going to know what might have been published.
What do you think?
There was a problem hiding this comment.
@driesvints Okay, I've moved the event into the else arm and also updated the comment on the $paths property, so instead of stating that the array contains the paths that were published, it instead states that the $paths property holds all of the publishable paths registered by that tag.
Is this better?
There was a problem hiding this comment.
@ryangjchandler I'll let Taylor review this one, thanks.
|
Thanks @taylorotwell! 🎉 |
This pull request introduces a new
VendorTagPublishedevent that is dispatched after successfully running thevendor:publishcommand.The event receives the
tagthat was published, as well as the array of paths that were published (source => location).The main reasoning behind this new event is allowing third-party packages to run particular actions after some of their publishable files have been actually been published.
E.g. you might set a file to be publishable using the tag
package-fileand wish to do something with that file after is has been published. This would allow you listen for theVendorTagPublishedevent from your package and run whatever logic you need.Question for reviewer: I'm firing the event regardless of whether any files were actually published. Is this okay, or should there be an
elsethat wraps the event dispatch? Left it as is because if you runvendor:publishwith an invalid tag, it shows the error "Unable to locate publishable resources." but also has the success message "Publishing complete.".