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

Support a binder badge #242

Merged
merged 7 commits into from Feb 13, 2018

Conversation

Projects
None yet
2 participants
@uribo
Copy link
Contributor

uribo commented Feb 12, 2018

My Proposal is here #239

Added new function use_binder_badge() that prints out Binder badge.

R/badge.R Outdated
#' Create a Binder badge
#'
#' This prints out the markdown which will display a Binder "badge", indicating
#' launch build your repository source codes on Binder <https://mybinder.org/>.

This comment has been minimized.

@jennybc

jennybc Feb 12, 2018

Member

This part of the sentence still doesn't make sense to me:

indicating launch build your repository source codes on Binder

I visited https://mybinder.org and tried to understand what's going on. Does this sound correct?

indicating that your repository can be launched in an executable environment on https://mybinder.org/.

If that's OK, let's use that wording (or something similar).

This comment has been minimized.

@uribo

uribo Feb 13, 2018

Author Contributor

Thank you for your suggestion. That is the tidy phrase :)

R/badge.R Outdated
#' @export
use_binder_badge <- function() {

if (uses_git(path = proj_get()) == TRUE) {

This comment has been minimized.

@jennybc

jennybc Feb 12, 2018

Member

You don't need the == TRUE. uses_git() already returns either TRUE or FALSE.

Also, should this be uses_github() in this case?

This comment has been minimized.

@uribo

uribo Feb 13, 2018

Author Contributor

Hmm. Indeed, I might as well change to uses_github() as you say.

Here, uses_github() is used the same way.

@jennybc

This comment has been minimized.

Copy link
Member

jennybc commented Feb 12, 2018

Will you also add a bullet to NEWS.md?

uribo added some commits Feb 13, 2018

`uses_github()` instead of `uses_git()`
tweaked based on discussion
add test for `binder_badge()`
it's works on exist git repository
Edit NEWS
🌟 added a `use_binder_bagde()` function
@uribo

This comment has been minimized.

Copy link
Contributor Author

uribo commented Feb 13, 2018

Done. But I'm sorry, lowered coverage.

@jennybc

This comment has been minimized.

Copy link
Member

jennybc commented Feb 13, 2018

Thanks!

@jennybc jennybc merged commit 1640ed0 into r-lib:master Feb 13, 2018

3 of 4 checks passed

codecov/patch 25% of diff hit (target 62.76%)
Details
codecov/project 62.46% (-0.3%) compared to dd4ab34
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@uribo uribo deleted the uribo:binder_badge branch Aug 10, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.