search

tophat / monodeploy

:monorail: Like semantic-release and Lerna, but for Yarn modern workspaces
https://tophat.github.io/monodeploy/
Apache License 2.0
106 stars 7 forks source link

Document publish lifecycle, with hooks and plugins #401

Open noahnu opened 3 years ago

noahnu commented 3 years ago

Is your feature request related to a problem? Please describe.

Add documentation with a diagram for all the lifecycle scripts and where hooks/plugins interact with the pipeline.

Describe the solution you'd like

Describe alternatives you've considered

Additional context

noahnu commented 2 years ago

Added lifecycle documentation, but we can still use a diagram for the plugins.

Papooch commented 1 year ago

As far as I know, there is only one plugin entry point, which is the onReleaseAvailable. Is a diagram really needed?

noahnu commented 1 year ago

It'd be living documentation that we add to as other hooks are exposed. We just haven't had a need for any other hooks for a while. I am considering adding a new hook to allow customizing what gets included in the autocommit. There's a use case to support committing back auto generated documentation in addition to changelog files.