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

Fix doc generation #389

Merged
merged 2 commits into from
Jan 27, 2023
Merged

Conversation

juanpcapurro
Copy link
Contributor

@juanpcapurro juanpcapurro commented Jan 25, 2023

while creating a new rule I found that the script responsible for generating the documentation was broken (well, not the script itself, but the metadata supplied to it) I fixed it and added a CI step to ensure that at least it doesn't crash.

I tried to get CI to also check that the latest version of the docs are commited to source control (with git diff docs --exit-code) but versions for files were different between CI and my machine. So it's out of scope for this PR 🙃 but I can create an issue to implement that later if there's consensus

@juanpcapurro juanpcapurro force-pushed the fix-doc-generation branch 2 times, most recently from 93996d2 to e2dc7ac Compare January 25, 2023 21:06
@juanpcapurro juanpcapurro marked this pull request as ready for review January 25, 2023 21:08
@dbale-altoros
Copy link
Collaborator

@juanpcapurro
This is great. I noticed before the generator had an error and it couldn't get the job done.
Will review with Franco

passing a string instead of the bare option was breaking the script
responsible for generating the docs
- update generated docs
- run the doc generation on CI so we don't break it again
- ensure the changes to the docs were commited to source control
@dbale-altoros dbale-altoros merged commit a2b8ea3 into protofire:master Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants