From 8dd14eff718f0c4b195c0acf75cfab2a0fde282f Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Mon, 29 Nov 2021 16:25:30 -0500 Subject: [PATCH 1/3] 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. --- lucene/MIGRATE.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/lucene/MIGRATE.md b/lucene/MIGRATE.md index 5eb87c61ea2b..f617f384f2bb 100644 --- a/lucene/MIGRATE.md +++ b/lucene/MIGRATE.md @@ -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. From 8286ca633a89afa3673934138463a20d1d392987 Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Mon, 29 Nov 2021 16:36:32 -0500 Subject: [PATCH 2/3] pad the table so it reads easier in plain-text view, does not impact markdown rendering --- lucene/MIGRATE.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/lucene/MIGRATE.md b/lucene/MIGRATE.md index f617f384f2bb..95ef1bee904c 100644 --- a/lucene/MIGRATE.md +++ b/lucene/MIGRATE.md @@ -23,17 +23,17 @@ All binary analysis packages (and corresponding Maven artifacts) have been renam 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| +| 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| +|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) From d96871b163764af55c395704ae87dc0fe5a0fa27 Mon Sep 17 00:00:00 2001 From: Robert Muir Date: Mon, 29 Nov 2021 16:42:31 -0500 Subject: [PATCH 3/3] Link to MIGRATE.md explicitly from README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f6c3619ebaa9..260bcbc08a70 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ comprehensive documentation, visit: - Nightly: - Build System Documentation: [help/](./help/) - Developer Documentation: [dev-docs/](./dev-docs/) +- Migration Guide: [lucene/MIGRATE.md](./lucene/MIGRATE.md) ## Building with Gradle