Add `--pre` to the recommended command to install jekyll-import. #1662

Merged
merged 1 commit into from Oct 29, 2013

Projects

None yet

3 participants

@carols10cents
Contributor

Since jekyll-import has not released any versions that are non-beta, running gem install jekyll-import as currently recommended by the error message results in a new error message:

ERROR:  Could not find a valid gem 'jekyll-import' (>= 0) in any repository
ERROR:  Possible alternatives: jekyll-import

This is confusing and unhelpful, so until jekyll-import releases a non-beta version, we should recommend using --pre.

I know the contribution guides say all PRs need tests, but I could not find any currently existing tests that assert on the output of the command, and I found myself really wanting to just use aruba but I'm loathe to add dependencies to projects without asking.

So if you'd be fine with me using aruba to write tests for this, I would be happy to. If you have another idea rather than using aruba, please give me some guidance. If this is not worth testing, well, here you are :)

@parkr
Member
parkr commented Oct 26, 2013

Maybe it'd be better to point to the docs? We don't want to have to release a version of this gem when we release jekyll-import. :)

@carols10cents carols10cents Referencing the documentation for jekyll-import installation
Currently, there are only beta releases of the jekyll-import gem, so to
install it, you have to do `gem install jekyll-import --pre`. Instead
of giving instructions that don't work right now, reference the
documentation. That way, this doesn't need to be updated again when
jekyll-import has a non-beta version; just the documentation will need
updating.
f0d0cbf
@carols10cents
Contributor

Sounds good, how does it look now?

@parkr
Member
parkr commented Oct 28, 2013

LGTM. @mattr-?

@mattr-
Member
mattr- commented Oct 29, 2013

❤️ Looks great! Thanks!

@mattr- mattr- merged commit 372e096 into jekyll:master Oct 29, 2013

1 check failed

default The Travis CI build failed
Details
@mattr- mattr- added a commit that referenced this pull request Oct 29, 2013
@mattr- mattr- Update history to reflect merge of #1662 1d72b13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment