Unifies the document and changelog structure (#70)

Fixes #69.

CHANGES.md

@@ -0,0 +1 @@
+doc/changes/changelog.md

README.md

@@ -1,6 +1,6 @@
 # Spark Exasol Connector
 
-<img alt="spark-exasol-connector logo" src="docs/images/spark-exasol-connector_128x128.png" style="float:left; padding:0px 10px 10px 10px;"/>
+<img alt="spark-exasol-connector logo" src="doc/images/spark-exasol-connector_128x128.png" style="float:left; padding:0px 10px 10px 10px;"/>
 
 [![Build Status][travis-badge]][travis-link]
 [![Codecov][codecov-badge]][codecov-link]
@@ -111,7 +111,10 @@ Please note that parameter values set on Spark configuration will have higher
 priority.
 
 For an example walkthrough please check
-[docs/example-walkthrough](docs/example-walkthrough.md).
+[doc/example-walkthrough](doc/example-walkthrough.md).
+
+Additionally, you can read about the latest changes in the
+[Changelog](doc/changes/changelog.md) file.
 
 ## Usage
 

doc/changes/changelog.md

@@ -0,0 +1,94 @@
+# Releases
+
+* [v0.3.0](changes-0.3.0.md)
+
+## v0.2.1
+
+> 2019 JUL 15
+
+* Fix bug with Decimal type conversion
+  [#44](https://github.com/exasol/spark-exasol-connector/issues/44)
+  [#47](https://github.com/exasol/spark-exasol-connector/pull/47) by @jpizagno
+* Fix bug with JDBC string null value setting
+  [#46](https://github.com/exasol/spark-exasol-connector/issues/46)
+  [#52](https://github.com/exasol/spark-exasol-connector/pull/52) by @morazow
+* Add Scala 2.12+ cross compilation for Spark versions above 2.4+
+  [#38](https://github.com/exasol/spark-exasol-connector/issues/38)
+  [#50](https://github.com/exasol/spark-exasol-connector/pull/50) by @morazow
+* Improve integration testing Docker startup time
+  [#51](https://github.com/exasol/spark-exasol-connector/issues/51)
+  [#53](https://github.com/exasol/spark-exasol-connector/pull/53) by @3cham
+* Add check that ensures host parameter value is an IPv4 address
+  [#42](https://github.com/exasol/spark-exasol-connector/issues/42)
+  [#48](https://github.com/exasol/spark-exasol-connector/pull/48)
+  [#43](https://github.com/exasol/spark-exasol-connector/issues/43)
+  [#49](https://github.com/exasol/spark-exasol-connector/pull/49) by @morazow
+
+## v0.2.0
+
+> 2019 JAN 21
+
+* Add Spark 2.4+ version
+  [#28](https://github.com/exasol/spark-exasol-connector/issues/28)
+  [#37](https://github.com/exasol/spark-exasol-connector/pull/37) by @morazow
+
+* Add Spark dataframe insert as Exasol table feature
+  [#32](https://github.com/exasol/spark-exasol-connector/issues/32)
+  [#37](https://github.com/exasol/spark-exasol-connector/pull/37) by @morazow
+
+## v0.1.3
+
+> 2018 DEC 10
+
+* Add tests for Unicode strings in predicate pushdown
+  [#12](https://github.com/exasol/spark-exasol-connector/issues/12)
+  [#34](https://github.com/exasol/spark-exasol-connector/pull/34) by @jpizagno
+* Spark dataframe `count` action pushdown
+  [#24](https://github.com/EXASOL/spark-exasol-connector/issues/24)
+  [#29](https://github.com/EXASOL/spark-exasol-connector/pull/29) by @morazow
+* Add `unhandledFilters` function to ExasolRelation
+  [#18](https://github.com/EXASOL/spark-exasol-connector/issues/18)
+  [#30](https://github.com/EXASOL/spark-exasol-connector/pull/30) by @morazow
+
+## v0.1.2
+
+> 2018 NOV 05
+
+* Use configurations from SparkConf when provided
+  [#4](https://github.com/EXASOL/spark-exasol-connector/issues/4)
+  [#23](https://github.com/EXASOL/spark-exasol-connector/pull/23) by @3cham
+* Change sub connections to use `handle` from main connection
+  [#22](https://github.com/EXASOL/spark-exasol-connector/issues/22)
+  [#25](https://github.com/EXASOL/spark-exasol-connector/pull/25) by @morazow
+* Add tests for different data types conversions
+  [#15](https://github.com/EXASOL/spark-exasol-connector/issues/15)
+  [#26](https://github.com/EXASOL/spark-exasol-connector/pull/26) by @jpizagno
+
+## v0.1.1
+
+> 2018 OCT 25
+
+* Use `date` and `timestamp` hints when creating where clause from Spark filters
+  [#13](https://github.com/EXASOL/spark-exasol-connector/issues/13)
+  [#17](https://github.com/EXASOL/spark-exasol-connector/pull/17) by @3cham
+* Enable user provided `schema` when reading from Exasol
+  [#5](https://github.com/EXASOL/spark-exasol-connector/issues/5)
+  [#19](https://github.com/EXASOL/spark-exasol-connector/pull/19) by @3cham
+* Fix ordering bug when pruning schema using required columns
+  [#21](https://github.com/EXASOL/spark-exasol-connector/pull/21) by @morazow
+
+## v0.1.0
+
+> 2018 OCT 04
+
+This is first release version which includes initial setup of project for
+continued improvements.
+
+* Initial working version (with known issues)
+* Initial predicate pushdown implementation
+  [#6](https://github.com/EXASOL/spark-exasol-connector/pull/6)
+  [#7](https://github.com/EXASOL/spark-exasol-connector/pull/7)
+* Build plugins such as linting and formatting
+* Travis CI based continuous build process
+* Basic manual Sonatype release script
+  [#11](https://github.com/EXASOL/spark-exasol-connector/pull/11)

doc/changes/changes-0.3.0.md

@@ -0,0 +1,42 @@
+## Spark Exasol Connector v0.3.0, released 2020-08-??
+
+### Bug Fixes
+
+* [#60](https://github.com/exasol/spark-exasol-connector/issues/60): Removed
+  `not null` constraint from string types (PR
+  [#63](https://github.com/exasol/spark-exasol-connector/pull/63)).
+
+### Improvements
+
+* [#45](https://github.com/exasol/spark-exasol-connector/issues/45): Improved
+  logging (PR [#56](https://github.com/exasol/spark-exasol-connector/pull/56)).
+* [#62](https://github.com/exasol/spark-exasol-connector/issues/62): Updated
+  Spark and Exasol versions (PR
+  [#64](https://github.com/exasol/spark-exasol-connector/pull/64)).
+* [#69](https://github.com/exasol/spark-exasol-connector/issues/69): Updated the
+  document and changelog structure. (PR
+  [#70](https://github.com/exasol/spark-exasol-connector/pull/70)).
+* Added project logo (PR
+  [#67](https://github.com/exasol/spark-exasol-connector/pull/67)).
+
+### Documentation
+
+* Fixed write example in readme (PR
+  [#58](https://github.com/exasol/spark-exasol-connector/pull/58)).
+
+### Dependency Updates
+
+* Updated sbt version from `1.2.8` to `1.3.13`.
+* Updated latest version of [sbt script](https://github.com/paulp/sbt-extras).
+* Updated ``org.scalatest:scalatest`` from `3.1.1` to `3.2.0`.
+* Updated ``org.mockito:mockito-core`` from `3.3.3` to `3.4.6`.
+* Updated ``org.testcontainers:jdbc`` from `1.13.0` to `1.14.3`.
+* Updated ``com.dimafeng:testcontainers-scala`` from `0.36.1` to `0.38.1`.
+
+#### Plugin Updates
+
+* Updated ``org.wartremover:sbt-wartremover`` from `2.4.5` to `2.4.10`.
+* Updated ``org.wartremover:sbt-wartremover-contrib`` from `1.3.4` to `1.3.8`.
+* Updated ``comeed3si9n:sbt-assembly`` from `0.14.10` to `0.15.0`.
+* Updated ``com.timushev.sbt:sbt-updates`` from `0.5.0` to `0.5.1`.
+* Updated ``com.xerial.sbt:sbt-sonatype`` from `3.9.2` to `3.9.4`.

project/Dependencies.scala

@@ -9,11 +9,11 @@ object Dependencies {
   private val SparkVersion = "2.4.5"
   private val ExasolJdbcVersion = "6.2.5"
 
-  private val ScalaTestVersion = "3.1.1"
+  private val ScalaTestVersion = "3.2.0"
   private val ScalaTestMockitoVersion = "1.0.0-M2"
-  private val MockitoVersion = "3.3.3"
-  private val ContainersJdbcVersion = "1.13.0"
-  private val ContainersScalaVersion = "0.36.1"
+  private val MockitoVersion = "3.4.6"
+  private val ContainersJdbcVersion = "1.14.3"
+  private val ContainersScalaVersion = "0.38.1"
 
   private val sparkCurrentVersion =
     sys.props.get("spark.currentVersion").getOrElse(SparkVersion)

project/build.properties

@@ -1 +1 @@
-sbt.version=1.2.8
+sbt.version=1.3.13

project/plugins.sbt

@@ -4,19 +4,19 @@ addSbtPlugin("io.get-coursier" % "sbt-coursier" % "1.0.3")
 
 // Adds a `wartremover` a flexible Scala code linting tool
 // http://github.com/puffnfresh/wartremover
-addSbtPlugin("org.wartremover" % "sbt-wartremover" % "2.4.5")
+addSbtPlugin("org.wartremover" % "sbt-wartremover" % "2.4.10")
 
 // Adds Contrib Warts
 // http://github.com/wartremover/wartremover-contrib/
-addSbtPlugin("org.wartremover" % "sbt-wartremover-contrib" % "1.3.4")
+addSbtPlugin("org.wartremover" % "sbt-wartremover-contrib" % "1.3.8")
 
 // Adds Extra Warts
 // http://github.com/danielnixon/extrawarts
 addSbtPlugin("org.danielnixon" % "sbt-extrawarts" % "1.0.3")
 
 // Adds a `assembly` task to create a fat JAR with all of its dependencies
 // https://github.com/sbt/sbt-assembly
-addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.14.10")
+addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.15.0")
 
 // Adds a `BuildInfo` tasks
 // https://github.com/sbt/sbt-buildinfo
@@ -32,7 +32,7 @@ addSbtPlugin("org.scoverage" % "sbt-scoverage" % "1.6.1")
 
 // Adds a `dependencyUpdates` task to check Maven repositories for dependency updates
 // http://github.com/rtimush/sbt-updates
-addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "0.5.0")
+addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "0.5.1")
 
 // Adds a `scalafmt` task for automatic source code formatting
 // https://github.com/lucidsoftware/neo-sbt-scalafmt
@@ -48,7 +48,7 @@ addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.9.2")
 
 // Adds a `sonatype` release tasks
 // https://github.com/xerial/sbt-sonatype
-addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "3.9.2")
+addSbtPlugin("org.xerial.sbt" % "sbt-sonatype" % "3.9.4")
 
 // Adds a `gnu-pgp` plugin
 // https://github.com/sbt/sbt-pgp