(maint) Add additional details on how to run spec tests #6964
Conversation
|
I've love to get some feedback here to make sure my instructions are clear and concise! |
CONTRIBUTING.md
Outdated
| # Install MSYS2 and MINGW development toolchain. When asked which components to | ||
| # install, select the third option. You need both MSYS2 and MINGW to compile the | ||
| # native dependencies installed with bundler. | ||
| ridk install |
There was a problem hiding this comment.
There's a way of running bundle install so we don't need the devkit installed. But it may not work the way I think it does until we do: https://tickets.puppetlabs.com/browse/PUP-7433
There was a problem hiding this comment.
I've generally used bundle install --without development extra
CONTRIBUTING.md
Outdated
| bundle install | ||
| # Run all of the tests, where 4 is the number of processors to use | ||
| bundle exec rake parallel:spec[4] | ||
| # Run a specific test |
There was a problem hiding this comment.
If you wanted to go one step further, you can specify line number for just one test, otherwise I'd say this is more likely to be a group of tests, or some other word artistry
|
CLA signed by all contributors. |
CONTRIBUTING.md
Outdated
| these tests. | ||
| `bundle exec rake parallel:spec[4]` | ||
|
|
||
| #### On Windows |
There was a problem hiding this comment.
Some of this info is repeated in https://github.com/puppetlabs/puppet/blob/master/docs/windows.md. Could you DRY it?
There was a problem hiding this comment.
There was a problem hiding this comment.
What do you mean by DRY?
There was a problem hiding this comment.
But also, thank you! I didn't realize those files were there!
There was a problem hiding this comment.
ah yeah, DRY = "don't repeat yourself" as we describe how to run tests in docs/quickstart.md, docs/windows.md and CONTRIBUTING.md
This commit just adds a few links and clarifies some steps to help folks developing against puppet in different environments.
melissa
force-pushed
the
maint/5.5.x/run-tests-windows-deets
branch
from
2b23aab to
74c759f
Compare
|
Okay, I cleaned this up a bit. Thank you for pointing out those redundancies, Josh! |
I've found there can be quite a bit of confusion of how exactly to run
spec tests, especially when it comes to windows. This commit attempts to
add some clarity around how to do that. A step by step guide might be
too prescriptive, but it should be quite helpful for those who are
unfamiliar with working in a windows environment.