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

Merged
merged 1 commit into from Oct 29, 2013

Conversation

Projects
None yet
4 participants
@carols10cents
Contributor

carols10cents commented Oct 26, 2013

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

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 26, 2013

Member

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. :)

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. :)

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.
@carols10cents

This comment has been minimized.

Show comment
Hide comment
@carols10cents

carols10cents Oct 27, 2013

Contributor

Sounds good, how does it look now?

Contributor

carols10cents commented Oct 27, 2013

Sounds good, how does it look now?

@parkr

This comment has been minimized.

Show comment
Hide comment
@parkr

parkr Oct 28, 2013

Member

LGTM. @mattr-?

Member

parkr commented Oct 28, 2013

LGTM. @mattr-?

@mattr-

This comment has been minimized.

Show comment
Hide comment
@mattr-

mattr- Oct 29, 2013

Member

❤️ Looks great! Thanks!

Member

mattr- commented Oct 29, 2013

❤️ Looks great! Thanks!

mattr- added a commit that referenced this pull request Oct 29, 2013

Merge pull request #1662 from carols10cents/fix-import-error-message
Add `--pre` to the recommended command to install jekyll-import.

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

1 check failed

default The Travis CI build failed
Details

mattr- added a commit that referenced this pull request Oct 29, 2013

@jekyll jekyll locked and limited conversation to collaborators Feb 27, 2017

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.