This is an automated email from the ASF dual-hosted git repository.
asf-gitbox-commits pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/mina-site.git
The following commit(s) were added to refs/heads/master by this push:
new 1302697a4 Updated the developer pages, adding some infos about javadoc
and RAT checks, plus a few typoes
1302697a4 is described below
commit 1302697a48940c4a1286bcf4d5aa90768ae21a2c
Author: emmanuel lecharny <[email protected]>
AuthorDate: Mon Jun 1 17:43:11 2026 +0200
Updated the developer pages, adding some infos about javadoc and RAT
checks, plus a few typoes
---
source/mina-project/developer-guide.md | 20 +++++++++++++++++---
1 file changed, 17 insertions(+), 3 deletions(-)
diff --git a/source/mina-project/developer-guide.md
b/source/mina-project/developer-guide.md
index 1560adc0f..96d991d00 100644
--- a/source/mina-project/developer-guide.md
+++ b/source/mina-project/developer-guide.md
@@ -17,11 +17,11 @@ title: Developer Guide
The current <em>MINA</em> code requires to be built with Java 8 for
<em>MINA</em> 2.0.X and <em>MINA</em> 2.1.X, and with Java 17 or higher for
<em>MINA</em> 2.2.X branch. See the table below.
</div>
-You need **Git** to check out the source code from our source code repository,
and [Maven](https://maven.apache.org/) 3.8 (pick the latest Maven version) to
build the source code (Building with Maven 3.0 will also work).
+You need **Git** to check out the source code from our source code repository,
and [Maven](https://maven.apache.org/) 3.8.5 at leat (pick the latest Maven
version) to build the source code (Building with Maven 4.0 has not been tested
yet).
Here are the Java version required for each branch. The Maven *pom.xml* has
been configured to enforce those versions:
-|Banche|Build Java required version |
+|Branche|Java required version |
|---|---|
| [2.0.X] | Java 1.8 |
| [2.1.X] | Java 1.8 |
@@ -127,12 +127,26 @@ java is hashed (/usr/bin/java)
```
### Step 0: Building MINA
-As weird as it sounds, for some unknown reason (most certainly a
misconfiguration in the Maven poms), we can't just run the release without
having previously build all the projects. This is done with the following
command :
+You may want to build MINA before starting to cut a relase. This is done with
the following command :
```bash
$ mvn clean install -Pserial
```
+It's also a good idea to check there is no missing license header:
+
+```bash
+$ mvn apache-rat:check -Pserial
+```
+
+Also check the Javadoc befoe generating the MINA site:
+
+```bash
+$ mvn javadoc:javadoc -Pserial
+```
+
+If you get some errors, get them fixed!
+
### Step 1: Tagging and Deploying
First you need to configure maven for using the good username for scp and
operation.
