This is an automated email from the ASF dual-hosted git repository. git-site-role pushed a commit to branch asf-site in repository https://gitbox.apache.org/repos/asf/plc4x-website.git
The following commit(s) were added to refs/heads/asf-site by this push: new 94360257d Site checkin for project PLC4X: Jenkins Tools 94360257d is described below commit 94360257d9ada76e21ddde9ea797003b2a193391 Author: jenkins <bui...@apache.org> AuthorDate: Sat Mar 23 20:16:16 2024 +0000 Site checkin for project PLC4X: Jenkins Tools --- developers/building.html | 15 +++------------ developers/release/release.html | 18 +++++++++--------- developers/release/validation.html | 12 ------------ users/getting-started/plc4py.html | 2 +- 4 files changed, 13 insertions(+), 34 deletions(-) diff --git a/developers/building.html b/developers/building.html index 1c48f72af..ac163a5d4 100644 --- a/developers/building.html +++ b/developers/building.html @@ -304,12 +304,6 @@ But there is a lot of good documentation out there.</p> <div class="sect2"> <h3 id="building_plc4x_with_maven">Building PLC4X with Maven</h3> <div class="paragraph"> -<p>In general all modules which are not considered production-ready are located in the <code>sandbox</code> section of the project.</p> -</div> -<div class="paragraph"> -<p>They are not built per default and are enabled by enabling the <code>with-sandbox</code> Maven profile.</p> -</div> -<div class="paragraph"> <p>As especially building the C++, and C# drivers requires building of some third party artifacts and increases build-time dramatically and requires setting up some additional third party tools, we have excluded these parts form the default Maven build.</p> </div> <div class="paragraph"> @@ -330,10 +324,7 @@ But there is a lot of good documentation out there.</p> <p><code>with-java</code>: Builds all Java related modules, integrations and examples</p> </li> <li> -<p><code>with-python</code>: Builds all Python related modules, integrations and examples (Also requires <code>with-sandbox</code>)</p> -</li> -<li> -<p><code>with-sandbox</code>: Builds the modules which are not yet considered stable enough to become part of the main distribution</p> +<p><code>with-python</code>: Builds all Python related modules, integrations and examples</p> </li> </ul> </div> @@ -378,7 +369,7 @@ As these profiles typically require some preparation and setup on your developme </div> <div class="literalblock"> <div class="content"> -<pre>mvn -P with-c,with-dotnet,with-go,with-java,with-python,with-sandbox install</pre> +<pre>mvn -P with-c,with-dotnet,with-go,with-java,with-python install</pre> </div> </div> <div class="paragraph"> @@ -389,7 +380,7 @@ As these profiles typically require some preparation and setup on your developme </div> <div class="literalblock"> <div class="content"> -<pre>mvn -P with-c,with-dotnet,with-go,with-java,with-python,with-sandbox install -DskipTests</pre> +<pre>mvn -P with-c,with-dotnet,with-go,with-java,with-python install -DskipTests</pre> </div> </div> <div class="paragraph"> diff --git a/developers/release/release.html b/developers/release/release.html index f8c601fce..c27b26b37 100644 --- a/developers/release/release.html +++ b/developers/release/release.html @@ -266,7 +266,7 @@ Please be sure to execute the release with a Java version 11 or the Karaf featur </div> <div class="listingblock"> <div class="content"> -<pre> mvn release:branch -P with-c,with-dotnet,with-go,with-java,with-python,with-sandbox,enable-all-checks -DbranchName=rel/{current-short-version}</pre> +<pre> mvn release:branch -P with-c,with-dotnet,with-go,with-java,with-python,enable-all-checks -DbranchName=rel/{current-short-version}</pre> </div> </div> <div class="ulist checklist"> @@ -281,7 +281,7 @@ Please be sure to execute the release with a Java version 11 or the Karaf featur </div> <div class="listingblock"> <div class="content"> -<pre> mvn release:prepare -P with-c,with-dotnet,with-go,with-java,with-python,with-sandbox,enable-all-checks</pre> +<pre> mvn release:prepare -P with-c,with-dotnet,with-go,with-java,with-python,enable-all-checks</pre> </div> </div> <div class="ulist checklist"> @@ -497,7 +497,7 @@ Otherwise, the non-default modules on develop will reference the old version whi </div> <div class="literalblock"> <div class="content"> -<pre>mvn release:branch -P with-c,with-dotnet,with-go,with-java,with-python,with-sandbox,enable-all-checks -DbranchName=rel/{minor-version}</pre> +<pre>mvn release:branch -P with-c,with-dotnet,with-go,with-java,with-python,enable-all-checks -DbranchName=rel/{minor-version}</pre> </div> </div> <div class="paragraph"> @@ -506,7 +506,7 @@ So in case of preparing the release branch for <code>0.13.0-SNAPSHOT</code> the </div> <div class="listingblock"> <div class="content"> -<pre> mvn release:branch -P with-c,with-dotnet,with-go,with-java,with-python,with-sandbox,enable-all-checks -DbranchName=rel/0.13</pre> +<pre> mvn release:branch -P with-c,with-dotnet,with-go,with-java,with-python,enable-all-checks -DbranchName=rel/0.13</pre> </div> </div> <div class="paragraph"> @@ -598,11 +598,11 @@ In order to prepare a release-candidate, the first step is switching to the corr </div> <div class="literalblock"> <div class="content"> -<pre>mvn release:prepare -P with-c,with-dotnet,with-go,with-java,with-python,with-sandbox,enable-all-checks</pre> +<pre>mvn release:prepare -P with-c,with-dotnet,with-go,with-java,with-python,enable-all-checks</pre> </div> </div> <div class="paragraph"> -<p>(The <code>-P with-c,with-dotnet,with-go,with-java,with-python,with-sandbox,enable-all-checks</code> tells maven to activate the all profiles that partition the build and makes sure the versions of all modules are updated as part of the release) +<p>(The <code>-P with-c,with-dotnet,with-go,with-java,with-python,enable-all-checks</code> tells maven to activate the all profiles that partition the build and makes sure the versions of all modules are updated as part of the release) In general the plugin will now ask you 3 questions:</p> </div> <div class="olist arabic"> @@ -715,7 +715,7 @@ If the commit history doesn’t look like this, something went wrong. </div> <div class="literalblock"> <div class="content"> -<pre>mvn release:rollback -P with-c,with-dotnet,with-go,with-java,with-python,with-sandbox,enable-all-checks</pre> +<pre>mvn release:rollback -P with-c,with-dotnet,with-go,with-java,with-python,enable-all-checks</pre> </div> </div> <div class="paragraph"> @@ -765,7 +765,7 @@ Here it automatically executes a maven build (You don’t have to do this, i <p>As the <code>apache-release</code> profile is also activated, this builds and tests the project as well as creates the JavaDocs, Source packages and signs each of these with your PGP key.</p> </div> <div class="paragraph"> -<p>We are intentionally not adding the other profiles, as these either produce binary artifacts that usually only work on the system they were compiled on (C++, .Net) or we haven’t found a good way to distribute them via Maven yet (Python) or deployment is disabled anyway (sandbox).</p> +<p>We are intentionally not adding the other profiles, as these either produce binary artifacts that usually only work on the system they were compiled on (C++, .Net) or we haven’t found a good way to distribute them via Maven yet (Python).</p> </div> <div class="paragraph"> <p>As this time the build is building with release versions, Maven will automatically choose the release url for deploying artifacts.</p> @@ -964,7 +964,7 @@ This is done by moving them inside the Apache SVN.</p> <p>Set the versions of the release branch to the previous version by using the <code>versions:set</code> plugin:</p> <div class="literalblock"> <div class="content"> -<pre>mvn versions:set -DprocessAllModules=true -P with-c,with-dotnet,with-go,with-java,with-python,with-sandbox,enable-all-checks</pre> +<pre>mvn versions:set -DprocessAllModules=true -P with-c,with-dotnet,with-go,with-java,with-python,enable-all-checks</pre> </div> </div> </li> diff --git a/developers/release/validation.html b/developers/release/validation.html index 4f0703785..503300478 100644 --- a/developers/release/validation.html +++ b/developers/release/validation.html @@ -346,18 +346,6 @@ Windows (PowerShell): Get-FileHash -Algorithm SHA512 .\apache-plc4x-code-generat <pre>find . -type f -name 'pom.xml' -exec grep -l "SNAPSHOT" {} \;</pre> </div> </div> -<div class="admonitionblock note"> -<table> -<tr> -<td class="icon"> -<i class="fa icon-note" title="Note"></i> -</td> -<td class="content"> -Especially in the <code>sandbox</code> there may be parts that are not formally released, <code>SNAPSHOT</code> versions in the <code>sandbox</code> therefore should not result in a <code>-1</code> vote …​ in the other parts however they should. -</td> -</tr> -</table> -</div> <div class="ulist checklist"> <ul class="checklist"> <li> diff --git a/users/getting-started/plc4py.html b/users/getting-started/plc4py.html index 5cec10fb5..cda6361ef 100644 --- a/users/getting-started/plc4py.html +++ b/users/getting-started/plc4py.html @@ -332,7 +332,7 @@ Once we have decided that PLC4Py is in a position to release we will publish to pypi.</p> </div> <div class="paragraph"> -<p>Navigate to the sandbox/plc4py directory and run. This will install plc4py in your global repository.</p> +<p>Navigate to the plc4py directory and run. This will install plc4py in your global repository.</p> </div> <div class="listingblock"> <div class="content">