Invoke configlet to create README during generate process.#722
Conversation
ghost
mentioned this pull request
They ARE generated on the existing |
| configletPath = "#{EXERCISM_RUBY_ROOT}/bin/configlet" | ||
| unless File.file?(configletPath) | ||
| raise Exception.new("Unable to find configlet, fetch using bin/fetch_configlet") | ||
| end |
There was a problem hiding this comment.
Should the configlet availability check happen earlier in the process?
|
|
||
| generators.each do |generator| | ||
| system("#{configletPath} generate #{EXERCISM_RUBY_ROOT} --only=#{generator.exercise.slug}") | ||
| end |
There was a problem hiding this comment.
I'm not entirely sure if this is the right way to be approaching this problem, I'll have to think about it for a while.
Is README generation related to test suite generation?
Will we always want to do both at the same time?
Should the code for doing this live inside the Generator with the other 3 things that it does already?
There was a problem hiding this comment.
Do we want to be able to ONLY regenerate the readme for a problem?
Does this need to be controlled by command line arguments to bin/generate?
ghost
closed this
ghost
deleted the
|
Configlet readme generation documentation: https://github.com/exercism/docs/blob/master/language-tracks/exercises/anatomy/readmes.md |
1 participant
Why?
According to the docs, README are auto-generated but that is not the case: https://github.com/exercism/ruby#readmes
Manually copy-pasting README from problem-specifications can lead to errors. This creates consistency across all READMEs.
What?
README is generated by calling configlet command
./configlet generate . --only=acronymHow Has This Been Tested?
rm exercises/acronym/README.mdTypes of changes
Checklist: