Skip to content

Commit

Permalink
chore(website): Add 0.12 docs and change the current version back to …
Browse files Browse the repository at this point in the history
…latest
  • Loading branch information
hutcheb committed Nov 23, 2024
1 parent 1bba169 commit 13edf00
Show file tree
Hide file tree
Showing 40 changed files with 92 additions and 82 deletions.
9 changes: 7 additions & 2 deletions website/antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,14 @@
site:
title: PLC4X
content:
sources:
sources:
- url: ../..
branches: HEAD
edit_url: '{web_url}/edit/develop/{path}'
start_path: website/asciidoc
- url: https://github.com/apache/plc4x.git
branches: ['rel/0.12']
start_path: website/asciidoc
ui:
bundle:
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
Expand All @@ -38,4 +41,6 @@ asciidoc:
attributes:
allow-uri-read: 'true'
output:
dir: ./target/site
dir: ./target/site
runtime:
fetch: true
7 changes: 6 additions & 1 deletion website/asciidoc/antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,16 @@
# under the License.
#
name: plc4x
version: '0.13.0-SNAPSHOT'
version: 'latest'
prerelease: True
title: PLC4X
start_page: users:index.adoc
nav:
- modules/ROOT/nav.adoc
- modules/users/nav.adoc
- modules/developers/nav.adoc
asciidoc:
attributes:
current-last-released-version: '0.13.0-SNAPSHOT'
current-full-version: '0.13.0'

6 changes: 3 additions & 3 deletions website/asciidoc/modules/developers/pages/building.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ repositories {
}
dependencies {
implementation group: 'org.apache.plc4x', name: 'plc4j-api', version: '{page-component-version}'
implementation group: 'org.apache.plc4x', name: 'plc4j-driver-s7', version: '{page-component-version}'
implementation group: 'org.apache.plc4x', name: 'plc4j-connection-pool', version: '{page-component-version}'
implementation group: 'org.apache.plc4x', name: 'plc4j-api', version: '{current-last-released-version}'
implementation group: 'org.apache.plc4x', name: 'plc4j-driver-s7', version: '{current-last-released-version}'
implementation group: 'org.apache.plc4x', name: 'plc4j-connection-pool', version: '{current-last-released-version}'
}
----
14 changes: 7 additions & 7 deletions website/asciidoc/modules/developers/pages/code-gen/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ Here's an example of a driver pom for building a `S7` driver for `java`:
<parent>
<groupId>org.apache.plc4x.plugins</groupId>
<artifactId>plc4x-code-generation</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
</parent>
<artifactId>test-java-s7-driver</artifactId>
Expand Down Expand Up @@ -231,21 +231,21 @@ Here's an example of a driver pom for building a `S7` driver for `java`:
<dependency>
<groupId>org.apache.plc4x.plugins</groupId>
<artifactId>plc4x-code-generation-driver-base-java</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
</dependency>
<dependency>
<groupId>org.apache.plc4x.plugins</groupId>
<artifactId>plc4x-code-generation-language-java</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
<!-- Scope is 'provided' as this way it's not shipped with the driver -->
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.apache.plc4x.plugins</groupId>
<artifactId>plc4x-code-generation-protocol-s7</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
<!-- Scope is 'provided' as this way it's not shipped with the driver -->
<scope>provided</scope>
</dependency>
Expand All @@ -263,7 +263,7 @@ The dependency:
<dependency>
<groupId>org.apache.plc4x.plugins</groupId>
<artifactId>plc4x-code-generation-driver-base-java</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
</dependency>
....

Expand All @@ -276,7 +276,7 @@ The definitions of both the `s7` protocol and `java` language are provided by th
<dependency>
<groupId>org.apache.plc4x.plugins</groupId>
<artifactId>plc4x-code-generation-language-java</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
<!-- Scope is 'provided' as this way it's not shipped with the driver -->
<scope>provided</scope>
</dependency>
Expand All @@ -289,7 +289,7 @@ and:
<dependency>
<groupId>org.apache.plc4x.plugins</groupId>
<artifactId>plc4x-code-generation-protocol-s7</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
<!-- Scope is 'provided' as this way it's not shipped with the driver -->
<scope>provided</scope>
</dependency>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ The same model is used for a wide variety of other projects, so it should be pre
- `release` contains the latest released state.
- Development is performed on the `develop` branch.
- Features are developed in Feature-Branches with a prefix `feature/`
- Each minor release has a corresponding release branch `rel/{page-component-version}`
- Each minor release has a corresponding release branch `rel/{current-last-released-version}`
- A release branch is spawned from `develop` only
- Bugfix releases don't have a dedicated release branch, they are just performed on the corresponding minor versions release branch

Expand Down
50 changes: 25 additions & 25 deletions website/asciidoc/modules/developers/pages/release/build-tools.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ According to SemVer, we have: Major, Minor and Bugfix releases.

For each new Major and Minor release we create a new branch at the beginning of a code-freeze phase.

So if currently the project version in develop is `{{page-component-version}}`, we create a branch `release/{code-generation-short-version}`.
So if currently the project version in develop is `{{current-last-released-version}}`, we create a branch `release/{code-generation-short-version}`.

When creating the branch is exactly the moment in which the version in `develop` is incremented to the next minor version.

Expand All @@ -50,7 +50,7 @@ This is the version the `develop` branch will be changed to.
mvn release:branch -DbranchName=releases/code-generation/{minor-version}

Per default the plugin suggests the next bugfix version as working version, however we want it to use the next minor version.
So in case of preparing the release branch for `{{page-component-version}}` the command would be the following:
So in case of preparing the release branch for `{{current-last-released-version}}` the command would be the following:

[subs="verbatim,attributes"]
----
Expand Down Expand Up @@ -130,7 +130,7 @@ After that, the following command will to all preparation steps for the release:
In general the plugin will now ask you 3 questions:
1. The version we want to release as (It will suggest the version you get by omitting the `-SNAPSHOT` suffix, keep it as it is)
2. The name of the tag the release commit will be tagged with in the SCM (Name it `releases/code-generation/{release-version}` (`releases/code-generation/{{page-component-version}}` in our case)
2. The name of the tag the release commit will be tagged with in the SCM (Name it `releases/code-generation/{release-version}` (`releases/code-generation/{{current-last-released-version}}` in our case)
3. The next development version (The version present in the pom after the release) (leave it as it is suggested by the plugin)
Usually for 1 and 3 the defaults are just fine, make sure the tag name is correct as this usually is different.
Expand All @@ -142,7 +142,7 @@ What the plugin now does, is automatically to execute the following operations:
1. Check we aren't referencing any `SNAPSHOT` dependencies.
2. Update all pom versions to the release version.
3. Run a build with all tests
4. Commit the changes (commit message: `[maven-release-plugin] prepare release releases/code-generation/{{page-component-version}}`)
4. Commit the changes (commit message: `[maven-release-plugin] prepare release releases/code-generation/{{current-last-released-version}}`)
5. Push the commit
6. Tag the commit
7. Update all poms to the next development version.
Expand All @@ -156,7 +156,7 @@ is in the correct state. Please select the release branch and verify the commit
image::release-git-history.png[]
It is important that the commit with the message "[maven-release-plugin] prepare release releases/code-generation/{{page-component-version}}" is tagged with the release tag (in this case releases/code-generation/{{page-component-version}})
It is important that the commit with the message "[maven-release-plugin] prepare release releases/code-generation/{{current-last-released-version}}" is tagged with the release tag (in this case releases/code-generation/{{current-last-released-version}})
If you check the commit itself, it should mainly consist of version updates like this:
Expand Down Expand Up @@ -230,20 +230,20 @@ The directory structure of this directory is as follows:
[subs="verbatim,attributes"]
----
./KEYS
./build-tools/code-generation/{{page-component-version}}
./build-tools/code-generation/{{page-component-version}}/rc1
./build-tools/code-generation/{{page-component-version}}/rc1/README
./build-tools/code-generation/{{page-component-version}}/rc1/RELEASE_NOTES
./build-tools/code-generation/{{page-component-version}}/rc1/apache-plc4x-code-generation-{{page-component-version}}-source-release.zip
./build-tools/code-generation/{{page-component-version}}/rc1/apache-plc4x-code-generation-{{page-component-version}}-source-release.zip.asc
./build-tools/code-generation/{{page-component-version}}/rc1/apache-plc4x-code-generation-{{page-component-version}}-source-release.zip.sha512
./build-tools/code-generation/{{current-last-released-version}}
./build-tools/code-generation/{{current-last-released-version}}/rc1
./build-tools/code-generation/{{current-last-released-version}}/rc1/README
./build-tools/code-generation/{{current-last-released-version}}/rc1/RELEASE_NOTES
./build-tools/code-generation/{{current-last-released-version}}/rc1/apache-plc4x-code-generation-{{current-last-released-version}}-source-release.zip
./build-tools/code-generation/{{current-last-released-version}}/rc1/apache-plc4x-code-generation-{{current-last-released-version}}-source-release.zip.asc
./build-tools/code-generation/{{current-last-released-version}}/rc1/apache-plc4x-code-generation-{{current-last-released-version}}-source-release.zip.sha512
----
I usually prepare exactly the same directory structure, starting with the {{page-component-version}} locally and then just import everything using the following command:
I usually prepare exactly the same directory structure, starting with the {{current-last-released-version}} locally and then just import everything using the following command:
[subs="verbatim,attributes"]
----
svn import {{page-component-version}} https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{{page-component-version}} -m"Staging of rc1 of PLC4X Build-Tools (Code-Generation) {{page-component-version}}"
svn import {{current-last-released-version}} https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{{current-last-released-version}} -m"Staging of rc1 of PLC4X Build-Tools (Code-Generation) {{current-last-released-version}}"
----
The `KEYS` file contains the PGP public key which belongs to the private key used to sign the release artifacts.
Expand All @@ -269,10 +269,10 @@ The following would be the one used to do our first TLP release:
[subs="verbatim,attributes"]
----
E-Mail Topic:
[VOTE] Apache PLC4X Build-Tools Code-Generation {{page-component-version}} RC1
[VOTE] Apache PLC4X Build-Tools Code-Generation {{current-last-released-version}} RC1

Message:
Apache PLC4X Build-Tools Code-Generation {{page-component-version}} has been staged under [2]
Apache PLC4X Build-Tools Code-Generation {{current-last-released-version}} has been staged under [2]
and it’s time to vote on accepting it for release.

All Maven artifacts are available under [1]. Voting will be open for 72hr.
Expand All @@ -281,7 +281,7 @@ The following would be the one used to do our first TLP release:
are required to pass.

Repository: https://gitbox.apache.org/repos/asf/plc4x-build-tools.git
Release tag: releases/code-generation/{{page-component-version}}
Release tag: releases/code-generation/{{current-last-released-version}}
Hash for the release tag: {replacethiswiththerealgitcommittag}

Per [3] "Before voting +1 PMC members are required to download
Expand All @@ -297,7 +297,7 @@ The following would be the one used to do our first TLP release:


[1] https://repository.apache.org/content/repositories/orgapacheplc4x-{somefourdigitnumber}
[2] https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{{page-component-version}}/rc1/
[2] https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{{current-last-released-version}}/rc1/
[3] https://www.apache.org/dev/release/validation.html#approving-a-release
[4] https://plc4x.apache.org/developers/release/validation.html
----
Expand All @@ -308,7 +308,7 @@ As it is sometimes to do the vote counting, if voting and discussions are going
[subs="verbatim,attributes"]
----
E-Mail Topic:
[DISCUSS] Apache PLC4X Build-Tools Code-Generation {{page-component-version}} RC1
[DISCUSS] Apache PLC4X Build-Tools Code-Generation {{current-last-released-version}} RC1

Message:
This is the discussion thread for the corresponding VOTE thread.
Expand All @@ -329,7 +329,7 @@ After the 72-our minimum wait period is over, and we have fulfilled the requirem
[subs="verbatim,attributes"]
----
E-Mail Topic:
[RESULT] [VOTE] Apache PLC4X Build-Tools Code-Generation {{page-component-version}} RC1
[RESULT] [VOTE] Apache PLC4X Build-Tools Code-Generation {{current-last-released-version}} RC1

Message:
So, the vote passes with 3 +1 votes by PMC members and one +1 vote by a non PMC member.
Expand All @@ -344,9 +344,9 @@ This is done by moving them inside the Apache SVN.
[subs="verbatim,attributes"]
----
svn move -m "Release Apache PLC4X {{page-component-version}}" \
https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{{page-component-version}}/rc1 \
https://dist.apache.org/repos/dist/release/plc4x/build-tools/code-generation/{{page-component-version}}
svn move -m "Release Apache PLC4X {{current-last-released-version}}" \
https://dist.apache.org/repos/dist/dev/plc4x/build-tools/code-generation/{{current-last-released-version}}/rc1 \
https://dist.apache.org/repos/dist/release/plc4x/build-tools/code-generation/{{current-last-released-version}}
----
This will make the release artifacts available and will trigger them being copied to mirror sites.
Expand Down Expand Up @@ -381,14 +381,14 @@ This has to be done with git
[subs="verbatim,attributes"]
----
git checkout release
git merge releases/code-generation/{{page-component-version}}
git merge releases/code-generation/{{current-last-released-version}}
----
When there are conflicts it could help to use the `theirs` merge strategy, i.e.,
[subs="verbatim,attributes"]
----
git merge -X theirs releases/code-generation/{{page-component-version}}
git merge -X theirs releases/code-generation/{{current-last-released-version}}
----
Possibly a manual conflict resolution has to be done afterwards. After that, changes need to
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ When using Maven, all you need to do is add this dependency:
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-api</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
</dependency>
----

Expand All @@ -43,7 +43,7 @@ For example in order to communicate with an `S7 device` using the `S7 Protocol`,
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-driver-s7</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
<scope>runtime</scope>
</dependency>
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ When using Maven, all you need to do is add this dependency:
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-api</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
</dependency>
----

Expand All @@ -171,7 +171,7 @@ For example in order to communicate using the `Modbus` protocol, you would need
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-driver-modbus</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
<scope>runtime</scope>
</dependency>
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,11 @@ Now you need to copy the `pcapng` file ideally to your development system.

The capture can be replayed by the tool you find in `plc4j/tools/capture-replay`.

Here simply look for the `target/plc4j-capture-replay-{page-component-version}-uber-jar.jar` and run:
Here simply look for the `target/plc4j-capture-replay-{current-last-released-version}-uber-jar.jar` and run:

[subs=attributes+]
----
java -jar target/plc4j-capture-replay-{page-component-version}-uber-jar.jar --input-file {path to capture} --output-device {name of the network device} --replay-speed 1 --loop true
java -jar target/plc4j-capture-replay-{current-last-released-version}-uber-jar.jar --input-file {path to capture} --output-device {name of the network device} --replay-speed 1 --loop true
----

The options `input-file` and `output-device` are mandatory, the rest is optional:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ To use the Connection Cache you have to add a dependency to the `plc4j-connectio
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-connection-cache</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
</dependency>
----
=====================================================================
Expand Down
2 changes: 1 addition & 1 deletion website/asciidoc/modules/users/pages/tools/scraper.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The Scraper can be found in the Maven module:
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-scraper</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
</dependency>
----

Expand Down
2 changes: 1 addition & 1 deletion website/asciidoc/modules/users/pages/tools/testing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The driver can be found in the Maven module
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-driver-mock</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
<scope>test</scope>
</dependency>
----
Expand Down
2 changes: 1 addition & 1 deletion website/asciidoc/modules/users/pages/transports/can.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Note this API is available since Apache PLC4X 0.9.
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-transport-can</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
</dependency>
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-transport-pcap-replay</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
</dependency>
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-transport-raw-socket</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
</dependency>
----

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<dependency>
<groupId>org.apache.plc4x</groupId>
<artifactId>plc4j-transport-serial</artifactId>
<version>{page-component-version}</version>
<version>{current-last-released-version}</version>
</dependency>
----

Expand Down
Loading

0 comments on commit 13edf00

Please sign in to comment.