[#519] Implement a golden generator executable #549
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chshersh
commented
Sep 18, 2021
Comment on lines
+168
to
+171
| import: exe-options | ||
| hs-source-dirs: golden | ||
| main-is: Main.hs | ||
| build-depends: base |
There was a problem hiding this comment.
I wasn't able to use common-options here because GHC outputs warning that base is not used in this executable (due to -Wunused-packages) 😒 So I don't use relude and warnings in this simple small file, just base, no ketchup, raw base
vrom911
approved these changes
Sep 18, 2021
vrom911
deleted the
chshersh/519-Implement-a-golden-generator-executable
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR implements
gg— a golden generator executable. It regenerates and updates on disk the content of all projects, scripts and default TOML config. It is useful when doing some massive boring updates (e.g. adding/removing GHC version support). Withggyou can just change the mainSummonercode and just runcrun ggto update all the projects.The second commit in this PR shows an example of updating years in all projects using
gg.It might be counter-intuitive to use
ggto generate tests and then test against tests themselves. But the main idea is that you usually don't useggafter each change. Golden tests ensure that nothing changes unexpectedly. However, when changing e.g. GHC version you expect changes in golden tests. So you can quickly regenerate them, check the diff to verify that the changes look ok and submit them 🙂 Ifgggenerated some unexpected results, you can always clean the mess withgitbecause all the projects under the version control