Update version to 2.2.0.

Author: jan-niestadt

README.md

@@ -11,6 +11,22 @@ To learn how to index and search your data, see the [official project site](http
 
 Learn about [BlackLab's structure and internals](./core/src/site/markdown/blacklab-internals.md) (work in progress). 
 
+## Changed: 'main' branch
+
+The branch that corresponds to BlackLab's latest release is now called _main_ instead of _master_.
+
+Local clones can either be removed and re-cloned, or you can rename the local branch with these commands:
+
+```bash
+git branch -m master main
+git fetch origin
+git branch -u origin/main main
+git remote set-head origin -a
+```
+
+Please note that _dev_, not _main_, is the default branch. This is the development
+branch, which should be considered unstable.
+
 ## Using BlackLab with Docker
 
 An experimental Docker setup is provided now. It will likely change in the future.

common/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
     </parent>
     <artifactId>blacklab-common</artifactId>
     <packaging>jar</packaging>

content-store/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
     </parent>
     <artifactId>blacklab-content-store</artifactId>
     <packaging>jar</packaging>

contrib/convert-and-tag/pom.xml

@@ -14,7 +14,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
         <relativePath>../../</relativePath>
     </parent>
 

contrib/legacy-docindexers/pom.xml

@@ -9,7 +9,7 @@
     <parent>
 	    <groupId>nl.inl.blacklab</groupId>
 	    <artifactId>blacklab-all</artifactId>
-	    <version>2.2.0-SNAPSHOT</version>
+	    <version>2.2.0</version>
         <relativePath>../../</relativePath>
     </parent>
 

core/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
     </parent>
     <artifactId>blacklab</artifactId>
     <packaging>jar</packaging>

core/src/site/markdown/changelog.md

@@ -1,16 +1,19 @@
 # Change Log
 
-## Improvements in 2.2.0-SNAPSHOT
+## Improvements in 2.2.0
 
 ### Changed
 
 * Make forward-index matching much less frequent, as it's difficult to predict when it will help, and it often hurts.
 * Split into several projects that each handle specific functionality. More to do here.
 * If either `wordsaroundhit` or `parameters.contextSize` are set to 0, don't include left and right context in the 
   results at all.  
+* The branch that corresponds to BlackLab's latest release is now called _main_ instead of _master_. The default 
+  branch remains the _dev_ branch (up to date but potentially unstable) 
 
 ### New
 
+* Added `instrumentation` modules to collect metrics using e.g. Prometheus.
 * Greatly improve startup time and passive memory usage.
 * Improved time to first result in (very) large indices.
 * Improved performance by instantiating fewer objects (e.g. using `IntArrayLists` instead of `Hit` objects)
@@ -31,7 +34,9 @@
 
 ### Fixed
 
-* Upgrade to `log4j-2.16.0` (fixes [CVE-2021-44228](https://nvd.nist.gov/vuln/detail/CVE-2021-44228) and [CVE-2021-45046](https://nvd.nist.gov/vuln/detail/CVE-2021-45046)).
+* Upgrade to `log4j-2.17.1` (fixes [CVE-2021-44228](https://nvd.nist.gov/vuln/detail/CVE-2021-44228) and [CVE-2021-45046](https://nvd.nist.gov/vuln/detail/CVE-2021-45046)).
+* Bug that could cause metadata values from a previously indexed document to also be added to the next.
+* YAML bug with metadata values containing newlines and colons.
 * Bug in `TermsWriter` that caused a crash when indexing more than 134M unique terms.
 * Deadlock because of fixed thread count and some subtasks getting run but not others. Now either allows entire search operation or queues it until later.
 * Fix not all hits always counted when grouping/sorting.
@@ -42,6 +47,7 @@
 * Prevent `ConcurrentModificationException` caused by not synchronizing.
 * Fix some caching bugs by consistently defining `hashCode()` and `equals()`.
 * Report correct search time (used to underreport).
+* Fixed slowdown when a lot of indexes are open at the same time.
 * Many smaller bugfixes.
 
 ### Removed

core/src/site/markdown/downloads.md

@@ -1,68 +1,26 @@
 # Downloads
 
-## Latest version
+## Releases
 
-To download and build the most recent release of BlackLab, clone the repository and build it using Maven:
+See the [GitHub releases page](https://github.com/INL/BlackLab/releases/) for the complete list. This may also include development versions you can try out. If you're looking for the BlackLab library or commandline tools (i.e. not BlackLab Server), choose the version with libraries included.
 
-	git clone git://github.com/INL/BlackLab.git
-	cd BlackLab
-	mvn install
-	
-To use the latest development version, switch to the 'dev' branch:
+Also see the [Change log](changelog.html).
 
-	git clone git://github.com/INL/BlackLab.git
-	cd BlackLab
-	git checkout dev
-	mvn install
-	
-If you're using Subversion, use:
+## Build your own
 
-	svn checkout https://github.com/INL/BlackLab/trunk BlackLab
-	cd BlackLab
-	mvn install
+To download and build the development version (bleeding edge, may be unstable), clone the repository and build it 
+using Maven:
 
-## Releases
+```bash
+git clone git://github.com/INL/BlackLab.git
+cd BlackLab
+# git checkout dev    # (the default branch)
+mvn clean package
+```
 
-See the [GitHub releases page](https://github.com/INL/BlackLab/releases/) for the complete list. This may also include development versions you can try out. If you're looking for the BlackLab library or commandline tools (i.e. not BlackLab Server), choose the version with libraries included.
-
-Also see the [Change log](changelog.html).
+To instead build the most recent release of BlackLab yourself:
 
-<table>
-	<tbody>
-		<tr>
-			<th>Version</th>
-			<th colspan='3'>Downloads</th>
-			<th>Description</th>
-		</tr>
-		<tr>
-			<td>SNAPSHOT</td>
-			<td></td>
-			<td><a href='https://github.com/INL/BlackLab/archive/dev.tar.gz'>Source (tgz)</a></td>
-			<td><a href='https://github.com/INL/BlackLab/archive/dev.zip'>Source (zip)</a></td>
-			<td>In-development version</td>
-		</tr>
-        <tr>
-            <td>v2.1.1</td>
-            <td><a href='https://github.com/INL/BlackLab/releases/download/v2.1.1/blacklab-server-2.1.1.war'>BlackLab Server WAR</a></td>
-            <td><a href='https://github.com/INL/BlackLab/releases/download/v2.1.1/blacklab-core.zip'>BlackLab Core JAR and libs</a></td>
-            <td><a href='https://github.com/INL/BlackLab/archive/v2.1.1.tar.gz'>Source (tgz)</a></td>
-            <td><a href='https://github.com/INL/BlackLab/archive/v2.1.1.zip'>Source (zip)</a></td>
-            <td>Bugfixes. MetadataFieldsWriter allows programmatically setting specials fields such as pidField.
-            Fixes log4j security issue by upgrading to 2.16.0.</td>
-        </tr>
-        <tr>
-            <td>v2.0.0</td>
-            <td><a href='https://github.com/INL/BlackLab/releases/download/v2.0.0/blacklab-server-2.0.0.war'>Binary (war)</a></td>
-            <td><a href='https://github.com/INL/BlackLab/archive/v2.0.0.tar.gz'>Source (tgz)</a></td>
-            <td><a href='https://github.com/INL/BlackLab/archive/v2.0.0.zip'>Source (zip)</a></td>
-            <td>New Java API. Multithreaded indexing and search. Saxon (XPath 3) support. Multiple metadata values per field possible. Many more improvements.</td>
-        </tr>
-		<tr>
-			<td>v1.7.2</td>
-			<td><a href='https://github.com/INL/BlackLab/releases/download/v1.7.2/blacklab-server-1.7.2.war'>Binary (war)</a></td>
-			<td><a href='https://github.com/INL/BlackLab/archive/v1.7.2.tar.gz'>Source (tgz)</a></td>
-			<td><a href='https://github.com/INL/BlackLab/archive/v1.7.2.zip'>Source (zip)</a></td>
-			<td>Made configuring input formats much easier, using a YAML (or JSON) file. Improved corpus structure information to allow better UI generation. Many other improvements.</td>
-		</tr>
-	</tbody>
-</table>
+```bash
+git checkout main
+mvn clean package
+```

engine/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
     </parent>
     <artifactId>blacklab-engine</artifactId>
     <packaging>jar</packaging>

instrumentation/instrumentation-impl/pom.xml

@@ -6,7 +6,7 @@
 <parent>
     <groupId>nl.inl.blacklab</groupId>
     <artifactId>blacklab-all</artifactId>
-    <version>2.2.0-SNAPSHOT</version>
+    <version>2.2.0</version>
     <relativePath>../../pom.xml</relativePath>
 </parent>
 <artifactId>blacklab-instrumentation-impl</artifactId>

instrumentation/instrumentation/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
     <artifactId>blacklab-instrumentation</artifactId>

interfaces/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
     </parent>
     <artifactId>blacklab-interfaces</artifactId>
     <packaging>jar</packaging>

mocks/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
     </parent>
     <artifactId>blacklab-mocks</artifactId>
     <packaging>jar</packaging>

pom.xml

@@ -7,7 +7,7 @@
     <groupId>nl.inl.blacklab</groupId>
     <artifactId>blacklab-all</artifactId>
     <packaging>pom</packaging>
-    <version>2.2.0-SNAPSHOT</version>
+    <version>2.2.0</version>
     <name>BlackLab Corpus Search</name>
     <description>The parent project for BlackLab Core and BlackLab Server.</description>
     <url>https://github.com/INL/BlackLab</url>

query-parser/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
     </parent>
     <artifactId>blacklab-query-parser</artifactId>
     <packaging>jar</packaging>

server/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
     </parent>
     <artifactId>blacklab-server</artifactId>
     <packaging>war</packaging>

text-pattern/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
     </parent>
     <artifactId>blacklab-text-pattern</artifactId>
     <packaging>jar</packaging>

tools/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
     </parent>
     <artifactId>blacklab-tools</artifactId>
     <packaging>jar</packaging>

util/pom.xml

@@ -6,7 +6,7 @@
     <parent>
         <groupId>nl.inl.blacklab</groupId>
         <artifactId>blacklab-all</artifactId>
-        <version>2.2.0-SNAPSHOT</version>
+        <version>2.2.0</version>
     </parent>
     <artifactId>blacklab-util</artifactId>
     <packaging>jar</packaging>