Skip tests tagged as document: false on docs generation #450
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.
When running the below command to re-generate API docs:
RAILS_ENV=test rake docs:generate
it will execute every single rspec test under
'spec/acceptance/**/*_spec.rb'
. It even executes the tests that are explicitly marked as:document: false
With this update, only the rspec tests that contribute to the generation of API documentation will be executed by default, which is much more efficient.
Aside: For our team, this reduced the amount of tests being executed during
docs generation down from 195 to 37.
Further notes
Relevant RSpec documentation: https://relishapp.com/rspec/rspec-core/docs/command-line/tag-option#exclude-examples-with-a-%60name:value%60-tag-and-@