You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We are committing generated text files to the repo because it is more straightforward. However, if someone forgets to update the generated file, it will get out of sync.
I would rather not commit these files in CI or generate them on demand.
✔️ Solution
Add a CI job that generates the files and checks if they are out-of-sync. If that is the case, the person will be forced to fix their PR before merging it.
📚 Context
We are committing generated text files to the repo because it is more straightforward. However, if someone forgets to update the generated file, it will get out of sync.
I would rather not commit these files in CI or generate them on demand.
✔️ Solution
Add a CI job that generates the files and checks if they are out-of-sync. If that is the case, the person will be forced to fix their PR before merging it.
Currently, we generate files with:
go generate
go run ./cmd/gen-docs
🐢
Also, let's add an "auto-generated" warning to the files as discussed at #170 (comment)
The text was updated successfully, but these errors were encountered: