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.

Sign up for GitHub

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

Jump to bottom

Run flow/scripts/generate-variables-docs.py and create doc update commit as part of OpenROAD bot #2444

Open
oharboe opened this issue Oct 12, 2024 · 2 comments · May be fixed by #2457
Open

Run flow/scripts/generate-variables-docs.py and create doc update commit as part of OpenROAD bot #2444

oharboe opened this issue Oct 12, 2024 · 2 comments · May be fixed by #2457

Comments

@oharboe
Copy link
Collaborator

oharboe commented Oct 12, 2024

Description

It is annoying to re-run flow/scripts/generate-variables-docs.py to update docs/user/FlowVariables.md as part of PRs, because it is likely to create conflicts. Especially if the format of docs/user/FlowVariables.md is amended.

Suggested Solution

Run flow/scripts/generate-variables-docs.py and create doc update commit as part of OpenROAD bot

Additional Context

No response
@oharboe
Copy link
Collaborator Author

oharboe commented Oct 12, 2024

Or... alternatively, create manual occasional standalone PRs to update docs. This would avoid merge conflicts and keep the docs up to date in practice.

@maliberty Good 'nuf? Close?

@luarss
Copy link
Contributor

luarss commented Oct 12, 2024

Agreed, this would be a good addition. It could also be nice to have a yaml linter in the CI to for formatting / checking missing yaml keys

@luarss luarss linked a pull request Oct 13, 2024 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[Docs] CI for variables.yaml + CI for docs update luarss/OpenROAD-flow-scripts
2 participants
@oharboe @luarss