diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 1049b873b..2988a4b72 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -74,4 +74,5 @@ jobs: [ -d target/opennlp-site/docs/2.5.5 ] && echo 'docs for 2.5.5 exists' [ -d target/opennlp-site/docs/2.5.6 ] && echo 'docs for 2.5.6 exists' [ -d target/opennlp-site/docs/2.5.6.1 ] && echo 'docs for 2.5.6.1 exists' - [ -d target/opennlp-site/docs/2.5.7 ] && echo 'docs for 2.5.7 exists' \ No newline at end of file + [ -d target/opennlp-site/docs/2.5.7 ] && echo 'docs for 2.5.7 exists' + [ -d target/opennlp-site/docs/3.0.0-M1 ] && echo 'docs for 3.0.0-M1 exists' \ No newline at end of file diff --git a/README.md b/README.md index c5a11d364..bd733efcf 100644 --- a/README.md +++ b/README.md @@ -26,11 +26,14 @@ Welcome to OpenNLP Site Source Code #### Build -`mvn clean install` +```bash +mvn clean install` +``` #### Test Site locally - starts a web server on Port 8080 -`mvn clean package jbake:inline -Djbake.port=8080 -Djbake.listenAddress=0.0.0.0` - +```bash +mvn clean package jbake:inline -Djbake.port=8080 -Djbake.listenAddress=0.0.0.0 +``` #### Build Bot Website is build via ASF BuildBot. You find it [here](https://ci.apache.org/). diff --git a/pom.xml b/pom.xml index b13e369a5..69c3718f8 100644 --- a/pom.xml +++ b/pom.xml @@ -593,6 +593,16 @@ ${project.build.directory}/distr/2.5.7 **/lib/**/* + + org.apache.opennlp + opennlp-distr + 3.0.0-M1 + false + zip + bin + ${project.build.directory}/distr/3.0.0-M1 + **/lib/**/* + diff --git a/src/main/jbake/assets/doap_opennlp.rdf b/src/main/jbake/assets/doap_opennlp.rdf index 4814b7403..475dff35b 100644 --- a/src/main/jbake/assets/doap_opennlp.rdf +++ b/src/main/jbake/assets/doap_opennlp.rdf @@ -37,8 +37,8 @@ Apache OpenNLP - 2025-12-11 - 2.5.7 + 2026-02-23 + 3.0.0-M1 diff --git a/src/main/jbake/content/docs/index.ad b/src/main/jbake/content/docs/index.ad index 478294eb2..d12552a05 100755 --- a/src/main/jbake/content/docs/index.ad +++ b/src/main/jbake/content/docs/index.ad @@ -27,6 +27,16 @@ The manual explains how the various OpenNLP components can be used and trained. NOTE: All the documentation is also included in the binary distribution. +== Apache OpenNLP {opennlp_3x_version} documentation + +* link:/docs/{opennlp_3x_version}/manual/opennlp.html[Apache OpenNLP Manual] +* link:/docs/{opennlp_3x_version}/opennlp.pdf[Apache OpenNLP PDF Manual] +* link:/docs/{opennlp_3x_version}/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools Javadoc] +// FIXME: Current M1 artifact only contains tools javadoc - see https://issues.apache.org/jira/browse/OPENNLP-1803 +// * link:/docs/{opennlp_3x_version}/apidocs/opennlp-tools-models/index.html[Apache OpenNLP Tools Models Javadoc] +// * link:/docs/{opennlp_3x_version}/apidocs/opennlp-uima/index.html[Apache OpenNLP UIMA Javadoc] +// * link:/docs/{opennlp_3x_version}/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP Morfologik Addon Javadoc] + == Apache OpenNLP {opennlp_version} documentation * link:/docs/{opennlp_version}/manual/opennlp.html[Apache OpenNLP Manual] diff --git a/src/main/jbake/content/docs/legacy.ad b/src/main/jbake/content/docs/legacy.ad index 41bb212ce..d9623570c 100755 --- a/src/main/jbake/content/docs/legacy.ad +++ b/src/main/jbake/content/docs/legacy.ad @@ -27,6 +27,13 @@ WARNING: This page contains the archived documentation. Please refer to link:/do There exists a manual and Javadoc API documentation for Apache OpenNLP. The manual explains how the various OpenNLP components can be used and trained. +== Apache OpenNLP 2.5.7 documentation +* link:/docs/2.5.7/manual/opennlp.html[Apache OpenNLP Manual] +* link:/docs/2.5.7/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools Javadoc] +* link:/docs/2.5.7/apidocs/opennlp-tools-models/index.html[Apache OpenNLP Tools Models Javadoc] +* link:/docs/2.5.7/apidocs/opennlp-uima/index.html[Apache OpenNLP UIMA Javadoc] +* link:/docs/2.5.7/apidocs/opennlp-morfologik-addon/index.html[Apache OpenNLP Morfologik Addon Javadoc] + == Apache OpenNLP 2.5.6.1 documentation * link:/docs/2.5.6.1/manual/opennlp.html[Apache OpenNLP Manual] * link:/docs/2.5.6.1/apidocs/opennlp-tools/index.html[Apache OpenNLP Tools Javadoc] diff --git a/src/main/jbake/content/download.ad b/src/main/jbake/content/download.ad index c2af9b8b6..c7f52abce 100755 --- a/src/main/jbake/content/download.ad +++ b/src/main/jbake/content/download.ad @@ -24,14 +24,40 @@ :toc: :toc-title: Content -== Latest Official Release +== Official Releases -Apache OpenNLP {opennlp_version} is now available for download. +Apache OpenNLP {opennlp_3x_version} and {opennlp_version} are now available for download. IMPORTANT: Please note that the _tar.gz_ archive contains file names longer than 100 characters and has been created using https://www.gnu.org/software/tar/[GNU tar,window=_blank] extensions. It must be untarred with a GNU compatible version of tar. + +=== 3.x Series + +[options="header"] +|=== +|.tar.gz | .zip + +| https://www.apache.org/dyn/closer.cgi/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-bin.tar.gz[apache-opennlp-{opennlp_3x_version}-bin.tar.gz] +https://downloads.apache.org/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-bin.tar.gz.sha512[sha512] +https://downloads.apache.org/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-bin.tar.gz.asc[asc] + +| https://www.apache.org/dyn/closer.cgi/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-bin.zip[apache-opennlp-{opennlp_3x_version}-bin.zip] +https://downloads.apache.org/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-bin.zip.sha512[sha512] +https://downloads.apache.org/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-bin.zip.asc[asc] + +| https://www.apache.org/dyn/closer.cgi/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-src.tar.gz[apache-opennlp-{opennlp_3x_version}-src.tar.gz] +https://downloads.apache.org/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-src.tar.gz.sha512[sha512] +https://downloads.apache.org/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-src.tar.gz.asc[asc] + +| https://www.apache.org/dyn/closer.cgi/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-src.zip[apache-opennlp-{opennlp_3x_version}-src.zip] +https://downloads.apache.org/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-src.zip.sha512[sha512] +https://downloads.apache.org/opennlp/opennlp-{opennlp_3x_version}/apache-opennlp-{opennlp_3x_version}-src.zip.asc[asc] +|=== + +=== 2.x Series + [options="header"] |=== |.tar.gz | .zip diff --git a/src/main/jbake/content/gradle-dependency.ad b/src/main/jbake/content/gradle-dependency.ad index 316345df5..48c9818e1 100755 --- a/src/main/jbake/content/gradle-dependency.ad +++ b/src/main/jbake/content/gradle-dependency.ad @@ -30,7 +30,21 @@ The Apache OpenNLP project publishes the library, javadoc and source code jars. To use OpenNLP in your https://gradle.org[Gradle,window=_blank] project, specify exactly one of the following dependencies, all transient dependencies are resolved automatically. -== Latest Release + +== 3.x Series + +To use OpenNLP as a library define the following dependency: + +[source,xml,indent=0,subs=attributes+] +---- +compile group: "org.apache.opennlp", name: "opennlp-runtime", version: "${opennlp_3x_version}" +compile group: "org.apache.opennlp", name: "opennlp-models", version: "${opennlp_3x_version}" +---- + +Only opennlp-runtime needs to be added as a dependency, and you can add additional modules +(e.g. opennlp-ml-maxent, opennlp-models, etc.) as required by your project. + +== 2.x Series === OpenNLP Tools Dependency To use the OpenNLP Tools define the following dependency: diff --git a/src/main/jbake/content/maven-dependency.ad b/src/main/jbake/content/maven-dependency.ad index c6bb086a7..f39dd3b40 100755 --- a/src/main/jbake/content/maven-dependency.ad +++ b/src/main/jbake/content/maven-dependency.ad @@ -30,7 +30,29 @@ The Apache OpenNLP project publishes the library, javadoc and source code jars. To use OpenNLP in your https://maven.apache.org[Maven,window=_blank] project, specify exactly one of the following dependencies, all transient dependencies are resolved automatically. -== Latest Release +== 3.x Series + +To use OpenNLP as a library define the following dependency: + +[source,xml,indent=0,subs=attributes+] +---- + + org.apache.opennlp + opennlp-runtime + ${opennlp_3x_version} + + + + org.apache.opennlp + opennlp-models + ${opennlp_3x_version} + +---- + +Only opennlp-runtime needs to be added as a dependency, and you can add additional modules +(e.g. opennlp-ml-maxent, opennlp-models, etc.) as required by your project. + +== 2.x Series === OpenNLP Tools Dependency To use the OpenNLP Tools define the following dependency: diff --git a/src/main/jbake/content/news/index.html b/src/main/jbake/content/news/index.html index 622877ab0..0c1c6a10c 100644 --- a/src/main/jbake/content/news/index.html +++ b/src/main/jbake/content/news/index.html @@ -1,5 +1,5 @@ title=News -date=2025-12-11 +date=2026-02-23 type=news status=published ~~~~~~ diff --git a/src/main/jbake/content/news/release-300-M1.ad b/src/main/jbake/content/news/release-300-M1.ad new file mode 100644 index 000000000..9cfd0a567 --- /dev/null +++ b/src/main/jbake/content/news/release-300-M1.ad @@ -0,0 +1,61 @@ +//// + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +//// += Apache OpenNLP 3.0.0-M1 released +Apache OpenNLP +2026-02-23 +:jbake-type: post +:jbake-tags: community +:jbake-status: published +:category: news +:idprefix: + +The Apache OpenNLP team is pleased to announce the release of Apache OpenNLP 3.0.0-M1. + +The Apache OpenNLP library is a machine learning based toolkit for the processing of natural language text. + +It supports the most common NLP tasks, such as tokenization, sentence segmentation, part-of-speech tagging, named entity extraction, chunking, parsing, and coreference resolution. + +Apache OpenNLP 3.0.0-M1 binary and source distributions are available for download from our link:/download.html[download page]. + +The OpenNLP library is distributed by Maven Central as well. See the link:/maven-dependency.html[Maven dependency] page for more details. + +== What's new in Apache OpenNLP 3.0.0-M1 + +The 3.x release line of Apache OpenNLP introduces no known breaking changes while significantly modularizing the project to improve library usage and future extensibility. +The core API remains stable and fully compatible with 2.x, so existing projects can continue using the opennlp-tools artifact without modifications. + +Key Highlights and Recommendations: + +* Modularization: The project is now organized into multiple modules: +* opennlp-api, opennlp-core, opennlp-cli, opennlp-extensions, ML modules (e.g., opennlp-ml-maxent, opennlp-ml-perceptron), and more. +* Users can include only the modules needed, reducing dependency footprint. +* Only opennlp-runtime is mandatory for basic functionality. +* CLI Stability: Existing command-line usage remains unchanged. + +For further details, check the full list of link:https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12311215&version=12355662[changes,role=external,window=_blank] via the project's issue tracker. + +== Migrating from 2.x to 3.x + +The 3.x release line of Apache OpenNLP introduces no known breaking changes but modularizes the project for better usage as a library and to support future extensibility. The core API remains stable and compatible with 2.x, but the project structure has been reorganized into multiple modules. + +That means, that you can continue to use the previous opennlp-tools artifact as a dependency. However, we strongly recommend to switch to the new modular structure and import only the components you need, which will result in a smaller dependency footprint. + +Only opennlp-runtime needs to be added as a dependency, and you can add additional modules (e.g. opennlp-ml-maxent, opennlp-models, etc.) as required by your project. For users of the traditional CLI toolkit, nothing changes with the 3.x release line. CLI usage remains stable + +--The Apache OpenNLP Team diff --git a/src/main/jbake/jbake.properties b/src/main/jbake/jbake.properties index a72ef789c..759ec0704 100755 --- a/src/main/jbake/jbake.properties +++ b/src/main/jbake/jbake.properties @@ -33,7 +33,8 @@ template.news.file=news.ftl asciidoctor.attributes.export=true asciidoctor.attributes.export.prefix= opennlp.version=2.5.7 -opennlp.next.version=2.5.8-SNAPSHOT +opennlp.3x.version=3.0.0-M1 +opennlp.next.version=3.0.0-SNAPSHOT opennlp.models=ud-models-1.3 opennlp.downloads=https://downloads.apache.org/opennlp/models ud.version=2.16 \ No newline at end of file