(v2.5.x) Fix antora metadata #1223
Conversation
abelsromero
force-pushed
the
fix-antora-metadata-v2.5.x
branch
2 times, most recently
from
0d11369 to
a5985bb
Compare
docs/antora.yml
Outdated
| asciidoctorj-epub3-version: 1.5.1 | ||
| asciidoctorj-pdf-version: 1.6.2 | ||
| asciidoctorj-pdf-version: 2.3.6 |
There was a problem hiding this comment.
We currently don't include asciidoctorj-pdf 2.x.x in the asciidoctorj 2.5.x distribution since this should be a major breaking change (at least according to semver rules).
Should we instead keep the last 1.x version here and reference 2.3.6 in the docs for asciidoctorj 3.x?
There was a problem hiding this comment.
This is more of a compatibility matrix to me, and since I have been using them in the maven-examples without issues I assumed the latest of both "j" and "j-pdf" were fine together.
I personally don't see a problem with that. If anything, we should add an/multiple pdf integration test to make sure the versions are compatible.
There was a problem hiding this comment.
pdf integration test
If we decide on that, I am definitely going to ask for a dependant to manage the version. We'll get an automatic PC that will test the compatibility as soon as j-pdf is out.
There was a problem hiding this comment.
Then we should likely also add asciidoctorj-pdf 2.3.6 to the distribution 2.5.x, right?
I am a bit hesitant to pull in a major version change in a bugfix release.
There was a problem hiding this 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.
abelsromero
force-pushed
the
fix-antora-metadata-v2.5.x
branch
from
a5985bb to
1bb32e0
Compare
Kind of change
Description
What is the goal of this pull request?
Update Antora metadata for branch v2.5.x
How does it achieve that?
Simply update
antora.ymlfile.Are there any alternative ways to implement this?
No
Are there any implications of this pull request? Anything a user must know?
No
Issue
If this PR fixes an open issue, please add a line of the form:
No issue.
Release notes
Please add a corresponding entry to the file CHANGELOG.adoc.
I don't think it makes sense, this metadata will be updated in the docs as soon as they are updated (nightly iirc).
It's not something that depends on a release.