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

Verify whether generated files are in sync #183

Closed
gligneul opened this issue Dec 4, 2023 · 1 comment · Fixed by #231
Closed

Verify whether generated files are in sync #183

gligneul opened this issue Dec 4, 2023 · 1 comment · Fixed by #231
Assignees
Labels
#feat:ci Feature: continuous integration
Milestone

Comments

@gligneul
Copy link
Contributor

gligneul commented Dec 4, 2023

📚 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:

🐢

Also, let's add an "auto-generated" warning to the files as discussed at #170 (comment)

@gligneul gligneul added the #feat:ci Feature: continuous integration label Dec 4, 2023
@gligneul gligneul added this to the 1.3.0 milestone Dec 4, 2023
@gligneul gligneul changed the title Verify if generated files are in sync Verify whether generated files are in sync Dec 4, 2023
@GMKrieger GMKrieger self-assigned this Dec 15, 2023
@gligneul
Copy link
Contributor Author

We should probably set-up a tools.go file to track the Go tools we use with go generate. See https://marcofranssen.nl/manage-go-tools-via-go-modules

@GMKrieger GMKrieger linked a pull request Jan 8, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
#feat:ci Feature: continuous integration
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants