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

Instruct github about some more auto-generated files #95

Merged
merged 1 commit into from
Oct 30, 2023

Conversation

nberth
Copy link
Collaborator

@nberth nberth commented Oct 27, 2023

Github shows changes to many files that are actually generated by drom. The new .gitattributes instructs it to hide the diffs by default.

Note: some of the generated files might still be relevant for review, and some others might be missing. So suggestions are welcome.

@nberth nberth force-pushed the new-gitattributes branch from f66b306 to 171b21e Compare October 27, 2023 12:54
Copy link
Contributor

@bclement-ocp bclement-ocp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks sensible. Maybe we could also consider having a CI workflow to check that those generated files are up-to-date (and possibly automatically re-generate them in a new commit)?

@ddeclerck
Copy link
Collaborator

ddeclerck commented Oct 27, 2023

Maybe you could have a single file with the list of generated files and their hashes, so that the reviewer at least "knows" they have changed, and check the diff only if he needs to. Now that I wrote this, I realize this is just the .drom file ;)

@bclement-ocp
Copy link
Contributor

Maybe you could have a single file with the list of generated files and their hashes, so that the reviewer at least "knows" they have changed, and check the diff only if he needs to. Now that I wrote this, I realize this is just the .drom file ;)

The way linguist-generated files are handled by the GitHub UI is that they are folded by default but still included in the "Review" tab (we were confused by this over on the Alt-Ergo repository), in a similar way as for large files, so this information would be in the UI already :)

@ddeclerck
Copy link
Collaborator

Maybe you could have a single file with the list of generated files and their hashes, so that the reviewer at least "knows" they have changed, and check the diff only if he needs to. Now that I wrote this, I realize this is just the .drom file ;)

The way linguist-generated files are handled by the GitHub UI is that they are folded by default but still included in the "Review" tab (we were confused by this over on the Alt-Ergo repository), in a similar way as for large files, so this information would be in the UI already :)

Then there is in fact no problem :p

@nberth nberth added the ok to review As its name says label Oct 27, 2023
@nberth nberth merged commit 246c005 into OCamlPro:master Oct 30, 2023
@nberth nberth deleted the new-gitattributes branch October 30, 2023 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ok to review As its name says
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants