This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
The following commit(s) were added to refs/heads/develop by this push:
new b869ce4d63 docs: Added the "enable-all-checks" to the release
documentation.
b869ce4d63 is described below
commit b869ce4d63fb17e9e25d5089367b18c7bf10fd65
Author: Christofer Dutz <[email protected]>
AuthorDate: Mon Oct 2 11:31:39 2023 +0200
docs: Added the "enable-all-checks" to the release documentation.
---
src/site/asciidoc/developers/release/release.adoc | 16 ++++++++--------
1 file changed, 8 insertions(+), 8 deletions(-)
diff --git a/src/site/asciidoc/developers/release/release.adoc
b/src/site/asciidoc/developers/release/release.adoc
index 4886e97a51..2accb0bace 100644
--- a/src/site/asciidoc/developers/release/release.adoc
+++ b/src/site/asciidoc/developers/release/release.adoc
@@ -29,14 +29,14 @@ IMPORTANT: Please be sure to execute the release with a
Java version 11 or the K
* [ ] Create release branch:
[subs="verbatim,attributes"]
----
- mvn release:branch -P with-c,with-dotnet,with-go,with-python,with-sandbox
-DbranchName=rel/{current-short-version}
+ mvn release:branch -P
with-c,with-dotnet,with-go,with-python,with-sandbox,enable-all-checks
-DbranchName=rel/{current-short-version}
----
[%interactive]
* [ ] Add a new section to the `RELEASE_NOTES` on `develop`
* [ ] Prepare the release:
[subs="verbatim,attributes"]
----
- mvn release:prepare -P with-c,with-dotnet,with-go,with-python,with-sandbox
+ mvn release:prepare -P
with-c,with-dotnet,with-go,with-python,with-sandbox,enable-all-checks
----
[%interactive]
* [ ] Perform the release:
@@ -157,14 +157,14 @@ This is the version the `develop` branch will be changed
to.
In contrast to normal builds, it is important to enable all profiles when
creating the branch as only this way will all modules versions be updated.
Otherwise, the non-default modules on develop will reference the old version
which will cause problems when building.
- mvn release:branch -P with-c,with-dotnet,with-go,with-python,with-sandbox
-DbranchName=rel/{minor-version}
+ mvn release:branch -P
with-c,with-dotnet,with-go,with-python,with-sandbox,enable-all-checks
-DbranchName=rel/{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
`{current-full-version}-SNAPSHOT` the command would be the following:
[subs="verbatim,attributes"]
----
- mvn release:branch -P with-c,with-dotnet,with-go,with-python,with-sandbox
-DbranchName=rel/{current-short-version}
+ mvn release:branch -P
with-c,with-dotnet,with-go,with-python,with-sandbox,enable-all-checks
-DbranchName=rel/{current-short-version}
----
The plugin will then aks for the version:
@@ -229,9 +229,9 @@ In order to prepare a release-candidate, the first step is
switching to the corr
After that, the following command will to all preparation steps for the
release:
- mvn release:prepare -P with-c,with-dotnet,with-go,with-python,with-sandbox
+ mvn release:prepare -P
with-c,with-dotnet,with-go,with-python,with-sandbox,enable-all-checks
-(The `-P with-c,with-dotnet,with-go,with-python,with-sandbox` 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)
+(The `-P
with-c,with-dotnet,with-go,with-python,with-sandbox,enable-all-checks` 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:
1. The version we want to release as (It will suggest the version you get by
omitting the `-SNAPSHOT` suffix)
@@ -279,7 +279,7 @@ NOTE: If the commit history doesn't look like this,
something went wrong.
If something goes wrong, you can always execute:
- mvn release:rollback -P with-c,with-dotnet,with-go,with-python,with-sandbox
+ mvn release:rollback -P
with-c,with-dotnet,with-go,with-python,with-sandbox,enable-all-checks
It will change the versions back and commit and push things.
@@ -464,7 +464,7 @@ If however for some reason it is needed to prepare a new RC
for the release. Ple
- Set the versions of the release branch to the previous version by using the
`versions:set` plugin:
- mvn versions:set -DprocessAllModules=true -P
with-c,with-dotnet,with-go,with-python,with-sandbox
+ mvn versions:set -DprocessAllModules=true -P
with-c,with-dotnet,with-go,with-python,with-sandbox,enable-all-checks
- Delete the tag locally:
