search

inukshuk / citeproc-ruby

A Citation Style Language (CSL) Cite Processor
101 stars 22 forks source link

Release notes for 2.0? #78

Closed jrochkind closed 2 years ago

jrochkind commented 2 years ago

I see that citeproc-ruby, along with csl and csl-styles, all had recent 2.0 releases.

The bump in major version number implies some possible backwards compatibility?

Is there any documentation available explaining what to be aware of there? I don't see a CHANGELOG file or use of "Github releases" feature; anywhere else I should be looking?

If not... should there be?

Thanks for your help, and work supporting ruby csl stuff!

jrochkind commented 2 years ago

Trying to investigate myself... there's a git tag for v1.2.0 in this repo, but it doesn't seem to have been released to rubygems?

Diff in this gem between 1.1.14 and 2.0.0: https://github.com/inukshuk/citeproc-ruby/compare/1.1.14...2.0.0 , just updates to ruby-csl 2.x, with note: "Update to CSL 1.0.2"

csl gem diff: https://github.com/inukshuk/csl-ruby/compare/1.6.0...2.0.0

Does the things to update to CSL 1.0.2 I guess?

So I guess that's the only change in 2.0 release? Are there any backwards incompatibilities to be aware of between CSL 1.0.1 and 1.0.2? The tiny version bump in CSL version makes me think hopefully not? So maybe no real backwards incompat in ruby CSL releases 2.x either?

inukshuk commented 2 years ago

Apologies for the lack of documentation. Yes, these are just major version bumps to make it easy to get all dependencies in line for CSL 1.0.2 styles and locales (somewhat rushed because we needed to update the Gems to run the tests on the new styles in the styles repo). The CSL changes are just minor, but if you want to use 1.0.2 styles or locales, you should update to the 2.x versions of the Gems. The csl-styles Gem itself already has the official 1.0.2 locales but not yet the styles -- I was going to wait for more 1.0.2 styles to hit the distribution repository before updating the Gem.

jrochkind commented 2 years ago

Thanks!

I have no immediate need to use 1.0.2 styles or locales (and didn't even know there was a 1.0.2 CSL release or what that means honestly!), but just like keeping my dependencies up to date. And don't mind if there are small changes due to updated styles/locales, if those are the latest best.

So sounds like it is unlikely to give me any problems to update now. Thanks! And thanks for your work on these, they are very useful!