search

apjanke / ronn-ng

Ronn-NG: An updated fork of ronn. Build man pages from Markdown.
MIT License
82 stars 15 forks source link

Gobble up n-ronn fixes for 0.10.1 #87

Closed apjanke closed 10 months ago

apjanke commented 1 year ago

Per this discussion in #82, the RubyGems folks started work on another "nronn" fork and made some enhancements, mostly for maintainability. To keep the tribes united and avoid the need for another fork, pull in their enhancements and see if Ronn-NG can serve that purpose itself.

Roll these out in a 0.10.1 release soon, since it looks like a bunch of Ronn-NG users have been using the prerelease for the last year or so!

References

TODO

TODO later in other tickets:

Most of these mean pulling in tnir's work from commits in n-ronn. Looks like the commits can't be applied directly because our repos have diverged a bit, mostly from them switching to GH Workflows. I'm new to GH Workflows, so if I adopt that, I'll want to work through it myself instead of just pulling tnir's commits.

deivid-rodriguez commented 1 year ago

@apjanke Even if you can't cherry-pick commits directly, you can still manually add a Co-authored-by: line to the commit message to give proper attribution to the author of the changes. See https://docs.github.com/en/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.

apjanke commented 1 year ago

I think I've pulled in all the major nronn fixes & enhancements now (except for enabling GitHub Pages as a doco site, which I'll do later), and I did a big Git commit history rewrite to tidy things up, and add "Co-authored-by:" attribution for @tnir on the relevant commits. It's merged to main now.

A 0.10.1pre2 prerelease will be coming out soon.

apjanke commented 1 year ago

Reopened this issue to include doing the 0.10.1 release itself, since that's going to need some further work, and I don't want to create a separate ticket for it and split the conversation/record.

There's some fiddly stuff with regenerating the ronn man pages, plus the gem publishing process, which will need at least one more prerelease for review, and I have to fix the broken Ruby/gems environment on my local Mac and make sure the Ronn-NG bundled stuff works with a "proper" Ruby 3.x environment.

apjanke commented 1 year ago

I think I've got my Ruby environment and RubyGems release act together a bit more now. Mostly boils down to "you need to set $GEM_HOME if you're running on a box with a locked-down system Ruby/Gems installation", I think.

I have published a new 0.10.1.pre2 preview to RubyGems, from the branch WIP/https-ify. If that works out, I'll merge it and send it out as the real 0.10.1 Ronn-NG release.

apjanke commented 1 year ago

Okay, still looking good. I've merged the pending changes to master, made a new 0.10.1.pre3 release, and published it to RubyGems. If no complaints in a couple days, I'll make an actual 0.10.1 release.

thesamesam commented 1 year ago

Did any problems come up in the end? Thank you for working on this!

apjanke commented 1 year ago

Uh, yeah: I'm working for a startup at my day job, and things got busy, and then our bank collapsed, and stuff.

But in terms of this code for ronn-ng, no issues, and I'll try to get a release rolled out this weekend! Sorry for the delay here.

thesamesam commented 1 year ago

Oh bloody hell, I'm sorry! Please don't worry about this, I just came across it and got curious.

But many thanks, whenever it happens, be it this weekend or many months away. I hope things are getting a bit better for you now!

apjanke commented 1 year ago

No worries! My work survived the SVB blowup just fine, and I do this ronn-ng stuff for fun. It's not a burden, and I appreciate getting engagement from users like this. :)

apjanke commented 10 months ago

Marking this as closed again. The fixes are pulled in and the tests are passing again now that https://github.com/apjanke/ronn-ng/issues/102 is (I think) fixed, so an 0.10.1 release will be coming out soon.