This is an automated email from the ASF dual-hosted git repository.
mawiesne pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/opennlp-site.git
The following commit(s) were added to refs/heads/main by this push:
new 007792e7 Adjusts release.ad and release-model.ad after preparations of
OpenNLP 2.5.0 - adds missing maven profiles for release prep steps - adjusts
path to src/bin artifacts for copy to dist/dev folder - improves formatting -
adds TOC Adjusts Maven and Gradle dependency pages - adds missing
opennlp-tools-models to list - adds missing opennlp-dl-gpu to list - removes
brat-annotator from list, see: OPENNLP-1634
007792e7 is described below
commit 007792e7b8369bd47bfbdaa28e335b02542c4e84
Author: Martin Wiesner <[email protected]>
AuthorDate: Fri Nov 8 09:17:38 2024 +0100
Adjusts release.ad and release-model.ad after preparations of OpenNLP 2.5.0
- adds missing maven profiles for release prep steps
- adjusts path to src/bin artifacts for copy to dist/dev folder
- improves formatting
- adds TOC
Adjusts Maven and Gradle dependency pages
- adds missing opennlp-tools-models to list
- adds missing opennlp-dl-gpu to list
- removes brat-annotator from list, see: OPENNLP-1634
---
src/main/jbake/content/gradle-dependency.ad | 31 +++++++----
src/main/jbake/content/maven-dependency.ad | 30 +++++++---
src/main/jbake/content/release-model.ad | 46 ++++++++--------
src/main/jbake/content/release.ad | 85 ++++++++++++++++-------------
4 files changed, 113 insertions(+), 79 deletions(-)
diff --git a/src/main/jbake/content/gradle-dependency.ad
b/src/main/jbake/content/gradle-dependency.ad
index 0261541b..316345df 100755
--- a/src/main/jbake/content/gradle-dependency.ad
+++ b/src/main/jbake/content/gradle-dependency.ad
@@ -42,6 +42,17 @@ dependencies {
}
----
+=== OpenNLP Tools Models Dependency
+
+To use the OpenNLP Tools Models define the following dependency:
+
+[source,indent=0,subs=attributes+]
+----
+dependencies {
+ implementation group: 'org.apache.opennlp', name: 'opennlp-tools-models',
version: '{opennlp_version}'
+}
+----
+
=== OpenNLP DL Dependency
To use the OpenNLP DL define the following dependency:
@@ -53,36 +64,36 @@ dependencies {
}
----
-=== OpenNLP UIMA Annotators Dependency
+=== OpenNLP DL GPU Dependency
-To use the OpenNLP UIMA Annotators define the following dependency:
+To use the OpenNLP DL GPU define the following dependency:
[source,indent=0,subs=attributes+]
----
dependencies {
- implementation group: 'org.apache.opennlp', name: 'opennlp-uima', version:
'{opennlp_version}'
+ implementation group: 'org.apache.opennlp', name: 'opennlp-dl-gpu', version:
'{opennlp_version}'
}
----
-=== OpenNLP Morfologik AddOn Dependency
+=== OpenNLP UIMA Annotators Dependency
-To use the OpenNLP Morfologik-Addon define the following dependency:
+To use the OpenNLP UIMA Annotators define the following dependency:
[source,indent=0,subs=attributes+]
----
dependencies {
- implementation group: 'org.apache.opennlp', name:
'opennlp-morfologik-addon', version: '{opennlp_version}'
+ implementation group: 'org.apache.opennlp', name: 'opennlp-uima', version:
'{opennlp_version}'
}
----
-=== OpenNLP Brat Annotator Dependency
+=== OpenNLP Morfologik AddOn Dependency
-To use the OpenNLP UIMA Annotators define the following dependency:
+To use the OpenNLP Morfologik-Addon define the following dependency:
[source,indent=0,subs=attributes+]
----
dependencies {
- implementation group: 'org.apache.opennlp', name: 'opennlp-brat-annotator',
version: '{opennlp_version}'
+ implementation group: 'org.apache.opennlp', name:
'opennlp-morfologik-addon', version: '{opennlp_version}'
}
----
@@ -93,7 +104,7 @@ To use the current version of the _main_ branch define the
following dependency:
----
dependencies {
- implementation group: 'org.apache.opennlp', name: 'opennlp-tools', version:
'2.2.1-SNAPSHOT'
+ implementation group: 'org.apache.opennlp', name: 'opennlp-tools', version:
'2.5.1-SNAPSHOT'
}
----
diff --git a/src/main/jbake/content/maven-dependency.ad
b/src/main/jbake/content/maven-dependency.ad
index 8b687413..e4e06b9c 100755
--- a/src/main/jbake/content/maven-dependency.ad
+++ b/src/main/jbake/content/maven-dependency.ad
@@ -43,6 +43,18 @@ To use the OpenNLP Tools define the following dependency:
</dependency>
----
+=== OpenNLP Tools Models Dependency
+To use the OpenNLP Tools Models define the following dependency:
+
+[source,xml,indent=0,subs=attributes+]
+----
+<dependency>
+ <groupId>org.apache.opennlp</groupId>
+ <artifactId>opennlp-tools-models</artifactId>
+ <version>{opennlp_version}</version>
+</dependency>
+----
+
=== OpenNLP DL Dependency
To use the OpenNLP DL define the following dependency:
@@ -55,38 +67,38 @@ To use the OpenNLP DL define the following dependency:
</dependency>
----
-=== OpenNLP UIMA Annotators Dependency
-To use the OpenNLP UIMA Annotators define the following dependency:
+=== OpenNLP DL GPU Dependency
+To use the OpenNLP DL GPU define the following dependency:
[source,xml,indent=0,subs=attributes+]
----
<dependency>
<groupId>org.apache.opennlp</groupId>
- <artifactId>opennlp-uima</artifactId>
+ <artifactId>opennlp-dl-gpu</artifactId>
<version>{opennlp_version}</version>
</dependency>
----
-=== OpenNLP Morfologik AddOn Dependency
-To use the OpenNLP Morfologik-Addon define the following dependency:
+=== OpenNLP UIMA Annotators Dependency
+To use the OpenNLP UIMA Annotators define the following dependency:
[source,xml,indent=0,subs=attributes+]
----
<dependency>
<groupId>org.apache.opennlp</groupId>
- <artifactId>opennlp-morfologik-addon</artifactId>
+ <artifactId>opennlp-uima</artifactId>
<version>{opennlp_version}</version>
</dependency>
----
-=== OpenNLP Brat Annotator Dependency
-To use the OpenNLP UIMA Annotators define the following dependency:
+=== OpenNLP Morfologik AddOn Dependency
+To use the OpenNLP Morfologik-Addon define the following dependency:
[source,xml,indent=0,subs=attributes+]
----
<dependency>
<groupId>org.apache.opennlp</groupId>
- <artifactId>opennlp-brat-annotator</artifactId>
+ <artifactId>opennlp-morfologik-addon</artifactId>
<version>{opennlp_version}</version>
</dependency>
----
diff --git a/src/main/jbake/content/release-model.ad
b/src/main/jbake/content/release-model.ad
index 26e8f698..329637c8 100644
--- a/src/main/jbake/content/release-model.ad
+++ b/src/main/jbake/content/release-model.ad
@@ -21,13 +21,15 @@
:jbake-tags: building
:jbake-status: published
:idprefix:
+:toc:
+:toc-title: Content
-## Release Preparation
+== Release Preparation
- Elect a release manager.
- Create a ticket for a new model release in
https://issues.apache.org/jira/browse/OPENNLP[JIRA,window=_blank]. If you do
not have permission to do so just ask to be given permissions on the mailing
list.
-## Steps for the Release Manager
+== Steps for the Release Manager
The following steps need only to be performed once.
@@ -50,15 +52,13 @@ svn commit -m "Added Key for <name>" KEYS
- Make sure you have your PGP key's password.
-## Release Steps
+== Release Steps
- Train the models
- Make sure to save the evaluation log for every model (adhere to the naming
conventions, see below).
- ZIP the evaluation logs.
-### Successful Model Release Preparation
-
-#### Perform the Model Release
+=== Perform the Model Release
- Create sha512 checksums
+
@@ -95,24 +95,26 @@ Check the dist/dev folder and if all looks well, open a
VOTE but do *not* move t
Make sure to adhere to the model naming conventions.
-#### Model Naming Conventions
+==== Model Naming Conventions
- The filenames of each model signify the model language, type,
https://universaldependencies.org/[Universal Dependency training
data,window=_blank] used, and version numbers.
-- The filename format is
`opennlp-[iso-language-code]-ud-[corpus]-[model-type]-[model-version]-[opennlp-version-used-for-training].bin`.
-- The evaluation logs must be zipped and adhere to the following format:
`opennlp-training-eval-logs-[model-version]-[opennlp-version-used-for-training].zip`.
It contains the evaluation logs for trained models.
-- For example, the model file `opennlp-de-ud-gsd-pos-1.0-1.9.3` is German
language, trained on the UD GSD corpus, and is a parts-of-speech model. It is
version 1.0 of the model, and it was trained using OpenNLP 1.9.3.
-
+- The filename format is +
+
`opennlp-[iso-language-code]-ud-[corpus]-[model-type]-[model-version]-[opennlp-version-used-for-training].bin`.
+- The evaluation logs must be zipped and adhere to the following format: +
+
`opennlp-training-eval-logs-[model-version]-[opennlp-version-used-for-training].zip`.
It contains the evaluation logs for trained models.
+- For example, the model file `opennlp-de-ud-gsd-pos-1.1-2.4.0` is German
language, trained on the UD GSD corpus, and is a parts-of-speech model.
+ It is version 1.1 of the model, and it was trained using OpenNLP 2.4.0.
NOTE: If other training data is used, the abbreviation `ud` needs to be
adjusted!
-#### Check the Model Release Artifacts
+=== Check the Model Release Artifacts
Perform basic checks against the release binary:
- Check signature of generated artifacts.
- Check presence and appropriateness of `LICENSE`, `NOTICE`, and `README`
files.
-#### Create a VOTE Thread
+=== Create a VOTE Thread
- Notify the developer mailing list of a new model vote. Be sure to replace
all values in `[]` with the appropriate values.
+
@@ -144,12 +146,12 @@ The vote passes if at least three binding +1 votes are
cast.
Thanks!
----
-## After a Successful Vote
+== After a Successful Vote
The vote is successful if at least 3 _+1_ votes are received from OpenNLP PMC
members after a minimum of 72 hours of sending the vote email.
Acknowledge the voting results on the mailing list in the VOTE thread.
-### Commit Distribution to SVN
+=== Commit Distribution to SVN
Commit the distribution via SVN to https://dist.apache.org/repos/dist/release:
@@ -160,24 +162,24 @@ svn co
https://dist.apache.org/repos/dist/release/opennlp/ dist
svn commit --username <username> -m "Adding OpenNLP Models <version>"
----
-### Delete Old Model Release(s)
+=== Delete Old Model Release(s)
To reduce the load on the ASF mirrors, projects are required to delete old
releases (see https://www.apache.org/legal/release-policy.html#when-to-archive).
Remove the old model release from SVN under
https://dist.apache.org/repos/dist/release/opennlp/models/. They are still
contained in the archives.
-### Update the Website
+=== Update the Website
Update the https://opennlp.apache.org/models.html[website,window=_blank] once
the new version appears in the Apache download mirrors (keep checking
https://www.apache.org/dyn/closer.cgi/opennlp/models/[window=_blank] until you
see something).
-#### Add News Item
+==== Add News Item
- Add a news item in `news/model-{model-type}-{xyz}.ad` by copying the
adjusted content:
+
----
= <MODEL_TYPE> Models for Apache OpenNLP released
Apache OpenNLP
-2022-01-03
+2024-11-01
:jbake-type: post
:jbake-tags: community
:jbake-status: published
@@ -203,13 +205,13 @@
https://dist.apache.org/repos/dist/dev/opennlp/<MODEL_TYPE>-<MODEL_VERSION>/open
--The Apache OpenNLP Team
----
-#### Commit Website Changes.
+==== Commit Website Changes.
- Commit the website changes.
- Rebuild opennlp-site and wait for site redeploy
- Test and review the website. Test that all download links are working.
-### Post-Release Steps
+=== Post-Release Steps
- Log the new version at
https://reporter.apache.org/addrelease.html?opennlp[window=_blank].
- Announce the new models on the OpenNLP Twitter.
@@ -244,7 +246,7 @@
https://dist.apache.org/repos/dist/dev/opennlp/<MODEL_TYPE>-<MODEL_VERSION>/open
--The Apache OpenNLP Team
----
-## After an Unsuccessful Vote
+== After an Unsuccessful Vote
The model release vote may fail due to an issue discovered in the release
candidate. If the vote fails the model release candidate should be canceled by:
diff --git a/src/main/jbake/content/release.ad
b/src/main/jbake/content/release.ad
index 748d3852..a29fa9e5 100644
--- a/src/main/jbake/content/release.ad
+++ b/src/main/jbake/content/release.ad
@@ -21,15 +21,17 @@
:jbake-tags: maven
:jbake-status: published
:idprefix:
+:toc:
+:toc-title: Content
-## Release Preparation
+== Release Preparation
- Elect a release manager.
- Create a ticket for a new release in
https://issues.apache.org/jira/browse/OPENNLP[JIRA]. If you do not have
permission to do so just ask to be given permissions on the mailing list.
- Review all of the https://issues.apache.org/jira/browse/OPENNLP[JIRA] issues
associated with the release. All issues should be resolved and closed.
- Any issues assigned to the release that are not complete should be assigned
to the next release. Any critical or blocker issues should be resolved on the
mailing list. Discuss any issues that you are unsure of on the mailing list.
-## Steps for the Release Manager
+== Steps for the Release Manager
The following steps need only to be performed once.
@@ -98,36 +100,42 @@ svn commit -m "Added Key for <name>" KEYS
export GPG_TTY=$(tty)
----
+== Release Steps
+=== Maven Release Preparation
-## Release Steps
-
-- Checkout the Apache OpenNLP main branch: `git clone
[email protected]:apache/opennlp.git`
-- (Optional) Execute a complete test (it can take several hours): `mvn test
-DOPENNLP_DATA_DIR=/path/to/opennlp-test-data/ -Peval-tests`
-- Check the current results of the eval build on the ASF Jenkins CI:
https://ci-builds.apache.org/job/OpenNLP/job/eval-tests/
-- Do a trial build: `mvn package -Papache-release,apache-gpg`
+- Checkout the Apache OpenNLP main branch: +
+ `git clone [email protected]:apache/opennlp.git`
+- (Optional) Execute a complete test (it can take several hours): +
+ `mvn test -DOPENNLP_DATA_DIR=/path/to/opennlp-test-data/ -Peval-tests`
+- Check the current results of the eval build on the ASF Jenkins CI: +
+ https://ci-builds.apache.org/job/OpenNLP/job/eval-tests/
+- Do a trial build: +
+ `mvn package -Papache-release,apache-gpg`
- Switch to a new branch with a format like *rel-opennlp-x.y.z.*.
-- Prepare the release: `mvn release:prepare -Papache-gpg` Answer the questions
appropriately. The tag name format should be *opennlp-x.y.z*.
-This command creates and pushes two new commits to the repository to reflect
the version changes. It also tags the release and pushes the branch.
-- Start an eval build for the tag via
https://ci-builds.apache.org/job/OpenNLP/job/eval-tests-releases/ (build can
take several hours)
-
-### Successful Maven Release Preparation
+- Prepare the release: +
+ `mvn release:prepare -Papache-release,apache-gpg` and answer the questions
appropriately. +
+ The tag name format should be *opennlp-x.y.z*. This command creates and
pushes two new commits to the repository to reflect the version changes. It
also tags the release and pushes the branch.
+- Start an eval build for the tag via +
+ https://ci-builds.apache.org/job/OpenNLP/job/eval-tests-releases/ (build can
take several hours)
-#### Perform the Release
+=== Perform the Release
-- Perform the release: `mvn release:perform -Papache-gpg`
+- Perform the release: +
+ `mvn release:perform -Papache-release,apache-gpg`
- This creates a staged repository at
https://repository.apache.org/#stagingRepositories
-- Check the staged repository and if all looks well, close the staging
repository but do *not* promote or release it at this time.
+- Check the staged repository and if all looks well.
+- Close the staging repository but do *not* promote or release it at this time.
- The build results are in `opennlp/target/checkout/target`. Do not modify or
delete these files.
-##### Put the artifacts to dist/dev
+=== Put the artifacts to dist/dev
-- Next, checkout the svn dist dev space from
https://dist.apache.org/repos/dist/dev/opennlp/
+- Next, checkout the *svn* dist dev space from
https://dist.apache.org/repos/dist/dev/opennlp/
- Create a new folder `opennlp-x.y.z`.
-- Add the files from `opennlp/target/checkout/target` to this folder.
+- Add all `*-src.*` and `*-bin.*` files from
`opennlp/opennlp-distr/target` to newly created folder.
- Commit the change set to the dist area. Check that the files are present in
https://dist.apache.org/repos/dist/dev/opennlp/opennlp-x.y.z
-#### Check the Release Artifacts
+=== Check the Release Artifacts
Perform basic checks against the release binary:
@@ -160,7 +168,7 @@ gpg --homedir . --output apache-opennlp-x.y.z-src.tar.gz
--decrypt apache-openn
- Check presence and appropriateness of `LICENSE`, `NOTICE`, and `README`
files.
-#### Create a VOTE Thread
+=== Create a VOTE Thread
- Notify the developer mailing list of a new version vote. Be sure to replace
all values in `[]` with the appropriate values.
@@ -228,7 +236,7 @@ Thanks!
<Your-Name>
----
-## After a Successful Vote
+== After a Successful Vote
The vote is successful if at least 3 _+1_ votes are received from OpenNLP PMC
members after a minimum of 72 hours of sending the vote email.
Acknowledge the voting results on the mailing list in the VOTE thread by
sending a mail.
@@ -252,16 +260,16 @@ Thanks to all voters. I'll proceed with the steps.
----
-### Release Nexus Staging Repository
+=== Release Nexus Staging Repository
Release the staging repository. This will make the artifacts available in the
Maven Central repository.
To do this go to the https://repository.apache.org[repository server], log in,
go to the staging area and release the staging repository linked to this release
-### Merge the Release Branch
+=== Merge the Release Branch
Merge the release branch into `main`.
-### Commit Distribution to SVN
+=== Commit Distribution to SVN
Move the distribution from dist/dev to dist/release via SVN
@@ -271,17 +279,17 @@ svn mv
https://dist.apache.org/repos/dist/dev/opennlp/opennlp-x.y.z https://dist
This will make the release artifacts available on dist.apache.org and the
artifacts will start replicating.
-### Delete Old Release(s)
+=== Delete Old Release(s)
To reduce the load on the ASF mirrors, projects are required to delete old
releases (see https://www.apache.org/legal/release-policy.html#when-to-archive).
Remove the old releases from SVN under
https://dist.apache.org/repos/dist/release/opennlp/.
-### Update the Website
+=== Update the Website
Update the website once the new version appears in the Apache download mirrors
(keep checking https://www.apache.org/dyn/closer.cgi/opennlp until you see
something):
-#### Update jbake.properties
+==== Update jbake.properties
Update the `jbake.properties` file to include the new version numbers:
@@ -290,7 +298,7 @@ opennlp.version=
opennlp.next.version=
```
-#### Add New Artifact Item
+==== Add New Artifact Item
Add a new artifactItem in the pom.xml for the new OpenNLP release. (This
automatically pulls in the details and javadocs for the new version when the
site is built.):
@@ -307,38 +315,39 @@ Add a new artifactItem in the pom.xml for the new OpenNLP
release. (This automat
</artifactItem>
----
-#### Update Documentation Links
+==== Update Documentation Links
Move the last version's links to the documentation to the Legacy Documentation
(https://opennlp.apache.org/docs/legacy.html) page. Add the following lines at
the beginning of `docs/legacy.ad`:
----
-### Apache OpenNLP ${previous.release} documentation
+=== Apache OpenNLP ${previous.release} documentation
* link:/docs/${previous.release}/manual/opennlp.html[Apache OpenNLP Manual]
* link:/docs/${previous.release}/apidocs/opennlp-tools/index.html[Apache
OpenNLP Tools Javadoc]
+*
link:/docs/${previous.release}/apidocs/opennlp-tools-models/index.html[Apache
OpenNLP Tools Models Javadoc]
+* link:/docs/${previous.release}/apidocs/opennlp-dl/index.html[Apache OpenNLP
DL Javadoc]
* link:/docs/${previous.release}/apidocs/opennlp-uima/index.html[Apache
OpenNLP UIMA Javadoc]
-*
link:/docs/${previous.release}/apidocs/opennlp-brat-annotator/index.html[Apache
OpenNLP BRAT Annotator Javadoc]
*
link:/docs/${previous.release}/apidocs/opennlp-morfologik-addon/index.html[Apache
OpenNLP Morfologik Addon Javadoc]
----
-#### Update main.yml
+==== Update main.yml
- Update the `main.yml` in `.github` to force a check on the docs for this new
version.
-#### Update doap_opennlp.rdf
+==== Update doap_opennlp.rdf
- Update the `doap_opennlp.rdf` file to reflect the new version number and
release date.
-#### Add News Item
+==== Add News Item
- Add a news item in `news/release-{xyz}.ad` by copying the content from
OpenNLP project `opennlp-distr/src/README`.
-#### Commit Website Changes.
+==== Commit Website Changes.
- Commit the website changes.
- Rebuild opennlp-site and redeploy the site (if Automatic Buildbot doesn't
kick in)
- Test and review the website. Test that all download links are working. Test
that the documentation is updated and can be viewed
-### Post-Release Steps
+=== Post-Release Steps
- Log the new version at https://reporter.apache.org/addrelease.html?opennlp.
- Announce the new version on the OpenNLP Twitter.
@@ -370,7 +379,7 @@ For a complete list of fixed bugs and improvements please
see the RELEASE_NOTES
The Apache OpenNLP Team
----
-## After an Unsuccessful Vote
+== After an Unsuccessful Vote
The release vote may fail due to an issue discovered in the release candidate.
If the vote fails the release should be canceled by:
