Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve command name docs #356

Merged
merged 3 commits into from
Jan 29, 2015
Merged

Improve command name docs #356

merged 3 commits into from
Jan 29, 2015

Conversation

gtd
Copy link
Contributor

@gtd gtd commented Dec 31, 2014

It actually took me several hours to figure out why I wasn't getting the coverage I expected, granted that's because my test suite is slow and I'm new to SimpleCov, but I think this additional paragraph will save someone some time.

@bf4
Copy link
Collaborator

bf4 commented Jan 28, 2015

Looks good. Would you mind adding some of the info from #340 about environmental variables? Let me know if you'd like any help adding it, or if you'd just like me to do it.

Quoted below for convenience.

Parallel testing

Using .simplecov rather than separately requiring SimpleCov multiple times is recommended if you are merging multiple test frameworks like Cucumber and RSpec that rely on each other, as invoking SimpleCov multiple times can cause coverage information to be lost.

You'll also want to use multiple 'command_names' to differentiate reports being merged in together.

See https://github.com/colszowka/simplecov/blob/master/lib/simplecov/command_guesser.rb#L19 that sets an unset command_name from the env if ENV['PARALLEL_TEST_GROUPS'] && ENV['TEST_ENV_NUMBER'], or from the command that ran the tests, or from any defined constants. to be sure, you may want to set it yourself, e.g. command_name "rails_app_#{$$}" # $$ is the processid

And then add something like merge_timeout 3600 # 1 hour should cover how long it takes the tests to run

@bf4 bf4 added the Docs label Jan 28, 2015
@gtd
Copy link
Contributor Author

gtd commented Jan 28, 2015

Okay, I added a paragraph about that and rebased. Let me know what you think.

@bf4
Copy link
Collaborator

bf4 commented Jan 29, 2015

@colszowka @envygeeks @sferik looks good to me. Any comments?

sferik added a commit that referenced this pull request Jan 29, 2015
@sferik sferik merged commit e65371d into simplecov-ruby:master Jan 29, 2015
@sferik
Copy link
Collaborator

sferik commented Jan 29, 2015

Very nice improvements to the README. Thanks!

@colszowka
Copy link
Collaborator

👍 Thanks!

@bf4
Copy link
Collaborator

bf4 commented Jan 31, 2015

@colszowka Could you add @envygeeks as a collab? Also, any thoughts about moving simplecov to an org?

jsonn pushed a commit to jsonn/pkgsrc that referenced this pull request Mar 14, 2015
## Bugfixes

0.9.2, 2015-02-18 ([changes](simplecov-ruby/simplecov@v0.9.1...v0.9.2))
====================

This is a minor bugfix release for simplecov-html, released as `0.9.0`. Due to the tight version constraint in the gemspec
a new release of simplecov had to be shipped to allow using simplecov-html `~> 0.9.0`.

  * The browser back / forward button should now work again. See [#36](simplecov-ruby/simplecov-html#36) and
    [#35](simplecov-ruby/simplecov-html#35). Thanks @whatasunnyday and @justinsteele for submitting PRs to fix this.
  * Fix "warning: possibly useless use of a variable in void context" See [#31](simplecov-ruby/simplecov-html#31). Thanks @cbandy
  * Always use binary file format. See [#32](simplecov-ruby/simplecov-html#32). Thanks @andy128k
  * Avoid slow file output with JRuby/Windows. See [#16](simplecov-ruby/simplecov-html#16). Thanks @pschambacher

Other than the release includes a bunch of mostly documentation improvements:

  * Update Rails path for Rails 4+. See [#336](simplecov-ruby/simplecov#336). Thanks @yazinsai
  * Encourage use of .simplecov to avoid lost files. See [#338](simplecov-ruby/simplecov#338). thanks @dankohn
  * Specified in the gemspec that simplecov needs ruby 1.8.7. See [#343](simplecov-ruby/simplecov#343). thanks @iainbeeston
  * Fix mispointed link in CHANGELOG.md. See [#353](simplecov-ruby/simplecov#353). Thanks @dleve123
  * Improve command name docs. See [#356](simplecov-ruby/simplecov#356). Thanks @gtd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants