Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Run make docsgen-cli on merge #12233

Open
rjan90 opened this issue Jul 15, 2024 · 0 comments · May be fixed by #12681
Open

Run make docsgen-cli on merge #12233

rjan90 opened this issue Jul 15, 2024 · 0 comments · May be fixed by #12681
Milestone

Comments

@rjan90
Copy link
Contributor

rjan90 commented Jul 15, 2024

Done Criteria

There is a mechanism to ensure that make docsgen-cli is run automatically on merge to the master branch.

Why Important

The docsgen-cli command auto-generates CLI documentation. In instances where contributors push a single line commit during a review, it might cause the docsgen-cli check to fail. This requires the person writing the PR to re-run make docsgen-cli, often context switching and waiting XX-minutes (TODO: write down time it takes) for the command to finish.

Additionally, most new contributors to Lotus are not aware of the need to run this command and running this automatically on merge can help alleviate some chores needed to do when contributing to the codebase.

User/Customer

Lotus contributors and maintainers.

Notes

@rjan90 rjan90 added this to FilOz Jul 15, 2024
@rjan90 rjan90 moved this to 📌 Triage in FilOz Jul 19, 2024
@rjan90 rjan90 added this to the DX-Streamline milestone Jul 23, 2024
@rjan90 rjan90 removed the status in FilOz Jul 23, 2024
@rjan90 rjan90 moved this to 🐱Todo in FilOz Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🐱 Todo
Development

Successfully merging a pull request may close this issue.

1 participant