Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

Document publish lifecycle, with hooks and plugins #401

Open
noahnu opened this issue Jul 13, 2021 · 3 comments
Open

Document publish lifecycle, with hooks and plugins #401

noahnu opened this issue Jul 13, 2021 · 3 comments

Comments

@noahnu
Copy link
Contributor

noahnu commented Jul 13, 2021

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
Copy link
Contributor Author

noahnu commented Aug 10, 2022

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

@Papooch
Copy link
Contributor

Papooch commented Jul 20, 2023

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

@noahnu
Copy link
Contributor Author

noahnu commented Jul 20, 2023

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants