Commit generated files #1410
Open
Commit generated files #1410
+20,716
−40
Conversation
This file contains hidden or 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
- Add `verify_generated` task to Rakefile - Always run rubocop on generated files
|
🚀 Preview deployment available at: https://e07354f1.rdoc-6cd.pages.dev (commit: 7ad0910) |
st0012
force-pushed
the
commit-generated-files
branch
from
456de24 to
7ad0910
Compare
kou
approved these changes
Aug 14, 2025
| rb_file = parser_file.gsub(/\.ry\z/, ".rb") | ||
| ruby "#{racc} -l -E -o #{rb_file} #{parser_file}" | ||
| sh "bundle exec racc -l -E -o #{rb_file} #{parser_file}" |
There was a problem hiding this comment.
In general, sh("command", "arg1", "arg2", ...) is safer than sh("command line"):
Suggested change
| sh "bundle exec racc -l -E -o #{rb_file} #{parser_file}" | |
| sh "bundle", "exec", "racc", "-l", "-E", "-o", rb_file, parser_file |
| rb_file = parser_file.gsub(/\.kpeg\z/, ".rb") | ||
| ruby "#{kpeg} -fsv -o #{rb_file} #{parser_file}" | ||
| sh "bundle exec kpeg -fsv -o #{rb_file} #{parser_file}" |
There was a problem hiding this comment.
Suggested change
| sh "bundle exec kpeg -fsv -o #{rb_file} #{parser_file}" | |
| sh "bundle", "exec", "kpeg", "-fsv", "-o", rb_file, parser_file |
| unless $?.success? | ||
| puts "Generated parser files are out of date!" | ||
| puts "Please run 'rake generate' and commit the changes." | ||
| puts "\nDifferences found:" |
There was a problem hiding this comment.
No argument puts may be more (a bit) readble than \n:
Suggested change
| puts "\nDifferences found:" | |
| puts | |
| puts "Differences found:" |
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.
Closes #1107 and will likely prevent issues like https://bugs.ruby-lang.org/issues/21541 in the future
With ignoring generated files in the source control, we always need one extra step to make the gem usable, which limits how the gem can be distributed (#1107) and make post-distribution issues easier to happen (which are in general harder to fix too).
If gems like
prismandrbsanddebugcan avoid this issue by committing generated files and verifying them on CI, I think we should do that too.