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

Added rdoc dependency #230

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Added rdoc dependency #230

wants to merge 1 commit into from

Conversation

smatyas
Copy link
Contributor

@smatyas smatyas commented Aug 10, 2017

Hi,

while I was creating an alpine-based docker container I found out that moonshot actually needs rdoc as a dependency, otherwise it fails with the following error:

bash-4.3# moonshot version
/usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require': cannot load such file -- rdoc (LoadError)
        from /usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require'
        from /usr/lib/ruby/gems/2.4.0/gems/github-markup-1.6.1/lib/github/markup/rdoc.rb:2:in `<top (required)>'
        from /usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require'
        from /usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require'
        from /usr/lib/ruby/gems/2.4.0/gems/github-markup-1.6.1/lib/github/markups.rb:2:in `<module:Markup>'
        from /usr/lib/ruby/gems/2.4.0/gems/github-markup-1.6.1/lib/github/markup.rb:102:in `instance_eval'
        from /usr/lib/ruby/gems/2.4.0/gems/github-markup-1.6.1/lib/github/markup.rb:102:in `<module:Markup>'
        from /usr/lib/ruby/gems/2.4.0/gems/github-markup-1.6.1/lib/github/markup.rb:24:in `<module:GitHub>'
        from /usr/lib/ruby/gems/2.4.0/gems/github-markup-1.6.1/lib/github/markup.rb:10:in `<top (required)>'
        from /usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require'
        from /usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require'
        from /usr/lib/ruby/gems/2.4.0/gems/vandamme-0.0.12/lib/vandamme/parser.rb:2:in `<top (required)>'
        from /usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require'
        from /usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require'
        from /usr/lib/ruby/gems/2.4.0/gems/vandamme-0.0.12/lib/vandamme.rb:2:in `<top (required)>'
        from /usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require'
        from /usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require'
        from /usr/lib/ruby/gems/2.4.0/gems/moonshot-2.0.0.beta3/lib/moonshot/build_mechanism/github_release.rb:7:in `<top (required)>'
        from /usr/lib/ruby/gems/2.4.0/gems/require_all-1.4.0/lib/require_all.rb:108:in `require'
        from /usr/lib/ruby/gems/2.4.0/gems/require_all-1.4.0/lib/require_all.rb:108:in `block in require_all'
        from /usr/lib/ruby/gems/2.4.0/gems/require_all-1.4.0/lib/require_all.rb:106:in `each'
        from /usr/lib/ruby/gems/2.4.0/gems/require_all-1.4.0/lib/require_all.rb:106:in `require_all'
        from /usr/lib/ruby/gems/2.4.0/gems/require_all-1.4.0/lib/require_all.rb:153:in `block in require_rel'
        from /usr/lib/ruby/gems/2.4.0/gems/require_all-1.4.0/lib/require_all.rb:152:in `each'
        from /usr/lib/ruby/gems/2.4.0/gems/require_all-1.4.0/lib/require_all.rb:152:in `require_rel'
        from /usr/lib/ruby/gems/2.4.0/gems/moonshot-2.0.0.beta3/lib/moonshot.rb:28:in `<top (required)>'
        from /usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require'
        from /usr/lib/ruby/2.4.0/rubygems/core_ext/kernel_require.rb:55:in `require'
        from /usr/lib/ruby/gems/2.4.0/gems/moonshot-2.0.0.beta3/bin/moonshot:2:in `<top (required)>'
        from /usr/bin/moonshot:22:in `load'
        from /usr/bin/moonshot:22:in `<main>'

Or is it actually a missing dependency in github-markup? It may be a bug in that project.

@jfarrell
Copy link
Contributor

is the changelog you have in your github repo rdoc and not markdown?

Github-markup excludes the dependency so it does not pull in every doc type dependency and leaves it up to the user to include the necessary dependency they are going to use. The vandamme gem, used by moonshot github_release build mechanism, does not declare rdoc as a dependency either as it expects you to include the format you need also

https://github.com/tech-angels/vandamme/blob/master/lib/vandamme/parser.rb#L48-L49

This is not a requirement for moonshot, just for anyone using the github release build mechanism with an rdoc changelog, if it was markdown or {format of choice here} it would break also. Probably better to update the moonshot documentation for github release build mechanism to require the necessary parser gem for your repos set changelog format

@askreet
Copy link
Contributor

askreet commented Aug 16, 2017

It would be nice if 'gem install moonshot' was all you had to do. Going to test this one locally and see how much more it adds, then probably merge it. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants