v2.1.0-rc2

Highlights 🚀

While we avoid breaking the API except for major versions, you may notice that you may need to do some little changes this time. This is because of fixes which inherently required this. But the fix on your side should be easy. In most cases you'll need to catch a possible exception when reading or writing crates and it should work again. Please tell us soon if something does not work for you!

• Support .ELN-style crates in all zip readers and writers by @Pfeil in #258
  • 📓We now support zip files which contain the crate not directly, but have a subfolder instead. This is one of the properties of the .ELN specification.
  • 🤐 Our Zip (and ZipStream) reader will search for this implicitly, so nothing has to be changed from your side to make it work. For readers, we think this makes reading simply more reliable. Note that we do not search the whole zip file for a crate but just in the first hierarchy of subfolders. We expect only one subfolder, but to work with edge cases, ro-crate-java will consider a few more. This works around hidden thumbnail folders and other unexpected properties.
  • ✍🏼 Our Zip (and ZipStream) writer strategies have according configuration methods to make them create such files: usingElnStyle() and withRootSubdirectory() do the exact same thing, just with different naming. Some may search for ELN functionality, others just want a subfolder. For ro-crate-java this is currently the same thing.
• Make specification examples (from readme) executable by @Pfeil in #256
  • 📄✅ Some of the examples in our guide did not work properly any more. To avoid this in future, we moved them to unit tests, where they are executable and tested. The readme now points to these examples.
• 🔧 Note, we also fixed a few bugs (see below). See if you are affected and consider updating to the release candidate to validate the fixes! 💛

Other

• chore(deps): update jacksonversion to v2.19.0 by @renovate in #248
• chore(deps): update dependency gradle to v8.14 by @renovate in #250
• chore(deps): update dependency gg.jte:jte to v3.2.1 by @renovate in #249
• Fix adding id property duplicates by @Pfeil in #257
• fix: enforce correct subfolder name for additional files in StaticPreview.saveAllToStream by @Pfeil in #261
• Next Version (v2.1.0-rc2) by @Pfeil in #255

Full Changelog: v2.1.0-rc1...v2.1.0-rc2