intuit / intuit/auto

Docs inconsistency for hook overview

Open
#1,980 3 comments 0 reactions 0 assignees View on GitHub
bug good first issue help wanted
Dominant language
TypeScript
Stars
2.5k
Forks
221
PR merge metrics
No merged PRs in 30d

Description

**Describe the bug**

The diagram detailing when hooks (especially release lifecycle hooks) are invoked for each command are incredibly useful when writing a plugin or trying to understand how different plugins will behave together.
However, when tracing through the code, I've noticed the following inconsistency(ies) between the [diagram](https://intuit.github.io/auto/hook-overview.png) and the implementation:
- `next` flow invokes `makeRelease` hook, but is missing from diagram

This can lead to confusion especially in relation to existing discussions of potential hook refactoring, ie:
- https://github.com/intuit/auto/issues/1054#issuecomment-780236482
- https://github.com/intuit/auto/issues/917

**Additional context**

Since the diagrams are images, it makes it difficult for others to contribute when flows / hooks are changed. I'm not familiar with the static site generation tooling, but would it be possible to diagram within the markdown itself using something like https://mermaid-js.github.io/mermaid/#/flowchart?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.