publishing Jekyll 3 updates

[chrylis]

A fix for Jekyll 3 compatibility was merged several months ago, but the version available on rubygems.org does not have it. Is there a timeline for deploying the fixed version?

[mojavelinux]

@paulrayner are you available to make a new release? Perhaps name it 1.0.1? Let me know if you need any assistance.

[paulrayner]

Yes. I'll take care of it this week.

Paul.
On 23/11/2015 11:39 AM, "Dan Allen" notifications@github.com wrote:

@paulrayner https://github.com/paulrayner are you available to make a
new release? Perhaps name it 1.0.1? Let me know if you need any assistance.

—
Reply to this email directly or view it on GitHub
#36 (comment)
.

[mojavelinux]

Great! Thanks @paulrayner! I'm here if you need me.

[paulrayner]

Running late on this due to other commitments last week. I'll get to it as
soon as I can.

Paul.

On Tue, Nov 24, 2015 at 11:58 PM, Dan Allen notifications@github.com
wrote:

Great! Thanks @paulrayner https://github.com/paulrayner! I'm hear if
you need me.

—
Reply to this email directly or view it on GitHub
#36 (comment)
.

[mitzimorris]

just ran into this problem:

/var/lib/gems/2.1.0/gems/jekyll-asciidoc-1.0.0/lib/jekyll-asciidoc.rb:84:in generate': undefined methodgetConverterImpl'

jekyll 3.0.0
running on a docker image, install instructions in Dockerfile are:

RUN export DEBIAN_FRONTEND=noninteractive TERM=linux &&
apt-get -y install ruby ruby-dev nodejs &&
gem install asciidoctor jekyll jekyll-asciidoc

[antonmoiseev]

Sorry not familiar with ruby at all, is there a workaround to run the pre release version? Install directly from a git repo or anything else?

[mojavelinux]

Just clone the repository and run rake install. That will build and install the gem.

[antonmoiseev]

ah, thanks, didn't realise the development version will be installed globally. However I had an issue running this command:

$ rake install
rake aborted!
Don't know how to build task 'install'

I didn't have the bundler installed, it caused the issue. This is probably should be a part of the installation guide, but don't know where would be the right place to add it, since it may be required by other installation options.

[mojavelinux]

Bundler is pretty much required these days anywhere you use Ruby. However, to help developers along who don't already have it installed, I've added instructions to the Rake build if Bundler fails to load:

jekyll-asciidoc: Bundler is required to build this gem.
You can install Bundler using the `gem install` command:

 $ gem install bundler

[mosabua]

Would be great to get a new release out supporting Jekyll 3 ... otherwise requires some hackery to just get this going.

[eshepelyuk]

Hello, is there any chance to get Jekyll3 support released soon ?

[mojavelinux]

@eshepelyuk, if you and @paulrayner agree, I'd be happy to add you as a maintainer of the gem so that you can share the responsibility of publishing the gem when needed.

[mkobit]

I am interested in trying out Jekyll 3 and AsciiDoctor together, but it doesn't look like this has been completed yet. I'm not familiar with Ruby publishing, but is all that is needed is for somebody to package and publish a new version?

[mojavelinux]

Yes, we are looking for someone to take on the responsibility of publishing releases to RubyGems.org. Even better if that could be more automated, but I'd be happy with having a release engineer doing it manually in the short term. If it comes down to it, I'd consider doing it, but with many other projects to release, I don't want to become a bottleneck.

[mkobit]

Note: To preface this, I know little about Bundler, Ruby, Rake, and Gems.

I took a look at what it would take to manually release this, and everything seems pretty straightforward. Most of this is documented in the README, but I'll list out the steps to make sure I'm not misinterpreting or missing something.

1. Get push access to asciidoctor/jekyll-asciidoc (this repository)
2. Set version in lib/jekyll-asciidoc/version.rb to 1.0.1
3. Commit change with release note -> git add lib/jekyll-asciidoc/version.rb && git commit -m "Release 1.0.1"
4. Get permission from one of the maintainers to publish new version to RubyGems
5. Run rake release (most of the magic happens here)
6. Set version in lib/jekyll-asciidoc/version.rb to 1.0.2.dev
7. Commit change with dev note -> git add lib/jekyll-asciidoc/version.rb && git commit -m "Begin development on next release"
8. Push up commits and tag to asciidoctor/jekyll-asciidoc -> git push --follow-tags

I would be willing to do this now since this has sat around for some time, and it is seems straightforward. I'm not sure if I would really be that comfortable being a maintainer of this, due to my unfamiliarity with the Ruby ecosystem.

I'd really like to see this new version get published soon so that users, including me, can start using AsciiDoc with Jekyll 3 without having to build this locally.

I'm not as concerned about automating the release of this package right now because the last commits were in December, but I think that would be interesting to look at. A lot of the work is currently done by the rake release task, but I would think that would need to change somewhat in order to deal with automation. Possibly have TravisCI/CircleCI to build and push gem on tag here, or just automatically release a new patch version on each change? I'm not as sure about that part.

[mojavelinux]

@mkobit You have a crystal clear understanding of what needs to be done. Nice summary!

First things first, in order to do the release, you'll need an account on RubyGems.org. Add a comment to this issue with your username once you've created one.

I only have one correction to the steps you identified. I don't think (8) is necessary. I'm pretty sure that rake release pushes the tags. But it doesn't hurt to run git push again since it won't duplicate anything it's already done.

I'd also like to see a corresponding release page on GitHub. This is done by navigating to the "release" tab and clicking the "Draft a new release" button. Select the tag and enter the same value in the title field. Then, add a few bullet points about what changed from the git log.

$ git shortlog v1.0.0..v1.0.1

Just pick out the notable stuff, namely references to issues.

(See https://github.com/asciidoctor/asciidoctorj/releases for ideas about what other information to add, though keep in mind it doesn't need to be that complex for now).

A lot of the work is currently done by the rake release task, but I would think that would need to change somewhat in order to deal with automation.

Exactly. Let's create a separate issue to track it. Ideally, rake release should do everything in your list. It will require encoding an API key into the Travis CI build so that it can push the gem to RubyGems.org. This will not only help this gem, but every gem in the Asciidoctor ecosystem.

I think I speak for everyone when I say that we appreciate you stepping up to the plate. Don't worry about being alone on this because, at the very least, I'm here to assist. This certainly isn't a life-long commitment :) We'll take it one release at a time.

[mkobit]

RubyGems handle: mkobit

[paulrayner]

To add new owners on RubyGems, it looks like I need to do 'gem owner jekyll-asciidoc -a {email-addr}'. Seems like gem ownership is based on email address rather than Rubygems account name based on http://guides.rubygems.org/command-reference/#gem-owner. Is that right? If so, I'll need email addresses to add new owners. Sorry about dropping the ball on getting this updated done, but I'm very glad to have help from others so it's not just me.

[paulrayner]

Done:

[mojavelinux]

Thanks @paulrayner! We're ready to roll. @mkobit, feel free to proceed and let me know if you need a hand with anything.

[mkobit]

1.0.1 has been published to RubyGems. I added a version badge to the README from https://badge.fury.io/, but it doesn't look like it has picked up the new version yet.

I wrote up release notes and linked to a few different PRs and issues - most of the commits were related to documentation and Jekyll 3.0.

[mojavelinux]

Amazing work Mike! We all thank you!

I switch the badge to shields.io, which resolved the version problem. We tend to prefer shields.io in the Asciidoctor ecosystem.

[mojavelinux]

@mkobit would you like to open a new issue to track automating the release from CI? Here's the matching issue in Asciidoctor core. asciidoctor/asciidoctor#1565