Comments (3)
Answering #1223 (comment)
Generally, testing the compatibility can be quite difficult, to me it means more than the API compiles, and writing integration tests that cover every possible use case can be challenging.
I'd like to use whatever the dependency claims through semantic versioning, if it claims to have a major breaking change, we should also only expose it in a major release.
I think that is also the way that other libraries like Spring Boot follow.
Yes, testing compatibility is tricky. I agree that it's more than compiling and that we can at most cover some common scenarios.
But I don't think semver applies here. Following the Boot example, recently snakeyaml was bumped from v1.33 to v2.0 in all branches (v2.7 and v3.x). As a Boot consumer you don't care about third-party dependencies it brings, and that's how I see the other asciidoctorj-* components in the distribution. It's true snakeyaml was a bit of a special case and in general major bumps even for third-party libs are not wanted, but not uncommon either.
Now, maybe the question is how we should deal with this here. It's not a bad idea to lock to the versions to the one on release. So that Asciidoctorj 2.5.0 started with j-pdf 1.6.x, they should go together.
But that means we should align them on every AsciidoctorJ release (same for -j-diagram, epub, ...) and keep maintenance branches for j-pdf, j-diagram, etc. which are not there now. That's why I think (for simplicity's sake), that as long we don't have major technical limitations, we should aim to support the latest. Fewer branches and less overall work.
In case of a major breaking change, we can always create a maintenance branch on demand, but not as default.
from asciidoctorj.
That's too funny, because I had exactly that example on my mind :D
While reviewing a PR last week that upgraded SnakeYaml I saw this comment from Andy:
https://stackoverflow.com/a/75875594/2779488
However, looking at the release notes for asciidoctor-pdf 2.0.0 it seems like this was only done to mark the official start for going with semver.
Let's go for it and look where we end up.
from asciidoctorj.
Let's go for it and look where we end up.
You were convincing me now, it seems I do not understand Boot policies.
But in the end, I still think we should use the latest to lower our work and cognitive load.
from asciidoctorj.
Related Issues (20)
- Integrate 'Coordinated Restore at Checkpoint' HOT 5
- Remove deprecated methods from Options and Attributes HOT 3
- Remove deprecated methods from Asciidoctor interface
- Remove deprecated methods from Document interface
- Remove deprecated methods from `extension` package
- Remove deprecated methods from `ast` package HOT 3
- included jruby version is vulnerable due to snakeyaml dependency HOT 3
- release 3.0.0-alpha.1 is gravely incompatible with earlier releases HOT 11
- 'UnsupportedOperationException' when passing immutable Map as options to 'createPhraseNode' HOT 1
- Ensure AsciidoctorJ version is returned always in CLI
- exception containing itself as nested exception, causing maven endless loop HOT 7
- feature request: render asciidoc to markdown HOT 3
- -s CLI option should be changed to -e to align with Asciidoctor
- Automatic-Module-Name is undefined in MANIFEST file HOT 4
- CLI should set :mkdirs option by default HOT 7
- Custom Macro HOT 1
- setContext not exposed in API HOT 1
- Include processor with all attributes resolution HOT 2
- highlight.js version 9 used by AsciiDoctorJ needs update as it is out of support HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from asciidoctorj.