Improve MIGRATE.md around analyzers artifacts. (#488)

* Improve MIGRATE.md around analyzers artifacts.

Move this to the very top of MIGRATE, the user needs to first be able to
pull in the artifacts, before doing anything else like trying to
compile, deal with renamed classes, etc.

Add a table of each package that got moved, with explicit old and new
names. Hopefully it helps search engines and users.

Link to MIGRATE.md explicitly from README.md
This commit is contained in:
Robert Muir 2021-11-29 17:04:15 -05:00
parent 70243ea811
commit 278316377c
No known key found for this signature in database
GPG Key ID: 817AE1DD322D7ECA
2 changed files with 19 additions and 5 deletions

View File

@ -33,6 +33,7 @@ comprehensive documentation, visit:
- Nightly: <https://ci-builds.apache.org/job/Lucene/job/Lucene-Artifacts-main/javadoc/>
- Build System Documentation: [help/](./help/)
- Developer Documentation: [dev-docs/](./dev-docs/)
- Migration Guide: [lucene/MIGRATE.md](./lucene/MIGRATE.md)
## Building with Gradle

View File

@ -17,6 +17,24 @@
# Apache Lucene Migration Guide
## Rename of binary artifacts from '**-analyzers-**' to '**-analysis-**' (LUCENE-9562)
All binary analysis packages (and corresponding Maven artifacts) have been renamed and are
now consistent with repository module 'analysis'. You will need to adjust build dependencies
to the new coordinates:
| Old Artifact Coordinates | New Artifact Coordinates |
|---------------------------------------------|--------------------------------------------|
|org.apache.lucene:lucene-analyzers-common |org.apache.lucene:lucene-analysis-common |
|org.apache.lucene:lucene-analyzers-icu |org.apache.lucene:lucene-analysis-icu |
|org.apache.lucene:lucene-analyzers-kuromoji |org.apache.lucene:lucene-analysis-kuromoji |
|org.apache.lucene:lucene-analyzers-morfologik|org.apache.lucene:lucene-analysis-morfologik|
|org.apache.lucene:lucene-analyzers-nori |org.apache.lucene:lucene-analysis-nori |
|org.apache.lucene:lucene-analyzers-opennlp |org.apache.lucene:lucene-analysis-opennlp |
|org.apache.lucene:lucene-analyzers-phonetic |org.apache.lucene:lucene-analysis-phonetic |
|org.apache.lucene:lucene-analyzers-smartcn |org.apache.lucene:lucene-analysis-smartcn |
|org.apache.lucene:lucene-analyzers-stempel |org.apache.lucene:lucene-analysis-stempel |
## Minor syntactical changes in StandardQueryParser (Lucene 9.1)
LUCENE-10223 adds interval functions and min-should-match support to StandardQueryParser. This
@ -82,11 +100,6 @@ the default stop tags returned by `JapaneseAnalyzer.getDefaultStopTags()` (i.e.
o.a.l.collation.ICUCollationAnalyzer is renamed to o.a.l.a.icu.ICUCollationKeyAnalyzer.
Also, its dependant classes are renamed in the same way.
## Rename of binary artifacts from '**-analyzers-**' to '**-analysis-**' (LUCENE-9562)
All binary analysis packages (and corresponding Maven artifacts) have been renamed and are
now consistent with repository module 'analysis'.
## Base and concrete analysis factories are moved / package renamed (LUCENE-9317)
1. Base analysis factories are moved to `lucene-core`, also their package names are renamed.