search

apache / plc4x

PLC4X The Industrial IoT adapter
https://plc4x.apache.org/
Apache License 2.0
1.32k stars 418 forks source link

[Bug]: Document case version error #1912

Open ZY945 opened 2 days ago

ZY945 commented 2 days ago

What happened?

I found that the release version is 0.12.0. But the branch ends with 0.12, and the document uses the version number of the branch.I hope we can unify it. https://plc4x.apache.org/plc4x/0.12/users/getting-started/plc4j.html#_using_the_plc4j_api_directly https://mvnrepository.com/artifact/org.apache.plc4x/plc4j-driver-s7/0.12.0 https://mvnrepository.com/artifact/org.apache.plc4x/plc4j-api/0.12.0

image image image

Version

0.12.0

Programming Languages

Protocols

hutcheb commented 2 days ago

Thanks for pointing that out, I have now updated the 0.12 branch to use 0.12.0 instead, in the antora.yml file.

The website will get updated on the next successful CI run. https://ci-builds.apache.org/blue/organizations/jenkins/PLC4X%2FPLC4X/detail/develop/

Thanks Again :)

chrisdutz commented 2 days ago

Well ... actually the branch name was 0.12 intentionally ... usually the branch contains all bugfix versions of a 0.12 release ... so it would usually contain 0.12.0, 0.12.1, 0.12.2 ... we're not doing that right now, but that's the normal pattern of maven git projects.

The tag should reflect a version .... because technically the rel/0.12.0 branch is in version 0.12.1-SNAPSHOT after the release.

hutcheb commented 2 days ago

I think it makes some sense to keep this section as 0.12 as we probably won't keep multiple minor versions of the docs on the website. image So that it doesn't change if a version 0.12.1 is ever released.

But having the 0.12.0 in the examples and docs I definitely makes sense.

I'm not sure there's a need to have a separate branch for docs for each minor release. So keeping the 0.12 docs on the rel/0.12 branch, then if a 0.12.1 is released, the website for version 0.12 would get incremented to 0.12.1 in the examples, and we wouldn't have the 0.12.0 referenced on the website anymore (Except for the release notes).