From 076ae2c5ac22dfab45f033eb16fa575327f406f5 Mon Sep 17 00:00:00 2001 From: Ivan Subotic Date: Thu, 13 Sep 2018 15:06:57 +0200 Subject: [PATCH] Releasing v2.0.0 (#996) * releasing-v2.0.0 --- README.md | 14 ++++++++ RELEASING.md | 1 - docs/DocsBuild.sbt | 2 +- docs/src/paradox/00-release-notes/index.md | 2 +- .../00-release-notes/{v1.8.0.md => v2.x.x.md} | 34 +++++++++++++------ salsah1/SalsahBuild.sbt | 2 +- webapi/WebapiBuild.sbt | 2 +- 7 files changed, 42 insertions(+), 15 deletions(-) rename docs/src/paradox/00-release-notes/{v1.8.0.md => v2.x.x.md} (51%) diff --git a/README.md b/README.md index c0f94a78f2..1441f86b82 100644 --- a/README.md +++ b/README.md @@ -172,6 +172,20 @@ feature (resources route): add route for resource creation ``` +## Release Versioning Convention + +The Knora project is following the Semantic Versioning convention for numbering the releases +as defined by [http://semver.org]: + +> Given a version number MAJOR.MINOR.PATCH, increment the: +> +> * MAJOR version when you make incompatible API changes, +> * MINOR version when you add functionality in a backwards-compatible manner, and +> * PATCH version when you make backwards-compatible bug fixes. + +Additionally, we will also increment the MAJOR version in the case when any kind of changes to existing +data would be necessary, e.g., any changes to the Knora-Base ontologies which are not backwards compatible. + ## Acknowledgments ![](https://www.yourkit.com/images/yklogo.png) diff --git a/RELEASING.md b/RELEASING.md index 2ef839f95c..797f9373d7 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -5,7 +5,6 @@ 1. Update the version number in `webapi/WebapiBuild.sbt`, `salsah1/SalsahBuild.sbt`, `docs/DocsBuild.sbt`. 1. Remove the `(not released yet)` text in the title of the release notes. 1. Create a new page with the next version number including the `(not released yet)` text and add page to TOC. - 1. Update links in the new page to point to correct release tag and milestone. 1. On Github - Create new milestone 1. On Github - Move any open issues from current release milestone to the next release milestone and so on. 1. On Github - Close current milestone. diff --git a/docs/DocsBuild.sbt b/docs/DocsBuild.sbt index 6c12220f15..d968af6852 100644 --- a/docs/DocsBuild.sbt +++ b/docs/DocsBuild.sbt @@ -16,7 +16,7 @@ lazy val docs = (project in file(".")). ). settings( // Set version string - version in ParadoxSite := "v1.7.1", + version in ParadoxSite := "v2.0.0", // Ghpages settings ghpagesNoJekyll := true, diff --git a/docs/src/paradox/00-release-notes/index.md b/docs/src/paradox/00-release-notes/index.md index 3f29e7de7f..5ff559accc 100644 --- a/docs/src/paradox/00-release-notes/index.md +++ b/docs/src/paradox/00-release-notes/index.md @@ -13,6 +13,6 @@ These are the release notes for each version of Knora. * [v1.5.0](v1.5.0.md) * [v1.6.0](v1.6.0.md) * [v1.7.0](v1.7.0.md) -* [v1.8.0](v1.8.0.md) +* [v2.x.x](v2.x.x.md) @@@ diff --git a/docs/src/paradox/00-release-notes/v1.8.0.md b/docs/src/paradox/00-release-notes/v2.x.x.md similarity index 51% rename from docs/src/paradox/00-release-notes/v1.8.0.md rename to docs/src/paradox/00-release-notes/v2.x.x.md index 33242c6aae..3348e24075 100644 --- a/docs/src/paradox/00-release-notes/v1.8.0.md +++ b/docs/src/paradox/00-release-notes/v2.x.x.md @@ -1,14 +1,18 @@ -# v1.8.0 Release Notes (not released yet) +# v2.x.x Release Notes -See the -[release](https://github.com/dhlab-basel/Knora/releases/tag/v1.8.0) and closed tickets on the -[v1.8.0 milestone](https://github.com/dhlab-basel/Knora/milestone/12) on Github. +## v2.0.0 +This is the first release with the new version numbering convention. From now on, if any changes +to the existing data is necessary for a release, then this release will have its major number increased. +Please see the [Release Versioning Convention](https://github.com/dhlab-basel/Knora#release-versioning-convention) +description. -## Required changes to existing data: +### Required changes to existing data: -## New features: +- a `knora-base:ListNode` must have at least one `rdfs:label`. (@github[#991](#990)) + +### New features: - add developer-centric docker-compose.yml for starting the Knora / GraphDB / Sipi / Salsah1 (@github[#979](#979)) - configure `webapi` and `salsah1` thorough environment variables (@github[#979](#979)) @@ -18,11 +22,21 @@ See the - update sbt to 1.2.1 (@github[#979](#979)) - remove Kamon monitoring (for now) since we don't see anything meaningful there. We probably will have to instrument Knora by hand and then use Kamon for access. (@github[#979](#979)) - update Dockerfiles for `webapi` and `salsah1` (@github[#979](#979)) -- Follow subClassOf when including ontologies in XML import schemas (@github[#991](#991)) +- follow subClassOf when including ontologies in XML import schemas (@github[#991](#991)) - add support for adding list child nodes (@github[#991](#990)) -- Add support for shared ontologies (@github[#987](#987)) +- add support for shared ontologies (@github[#987](#987)) -## Bugfixes: +### Bugfixes: - trouble with xml-checker and/or consistency-checker during bulk import (@github[#978](#978)) -- Ontology API error with link values (@github[#988](#988)) +- ontology API error with link values (@github[#988](#988)) + +## v2.0.1 (not release yet) + +### Bugfixes: + +## v2.1.0 (not release yet) + +### New features: + +### Bugfixes: \ No newline at end of file diff --git a/salsah1/SalsahBuild.sbt b/salsah1/SalsahBuild.sbt index bfeba14390..1f6e101a2a 100644 --- a/salsah1/SalsahBuild.sbt +++ b/salsah1/SalsahBuild.sbt @@ -4,7 +4,7 @@ import NativePackagerHelper._ lazy val salsahCommonSettings = Seq( organization := "org.knora", name := "salsah", - version := "1.7.1", + version := "2.0.0", scalaVersion := "2.12.4" ) diff --git a/webapi/WebapiBuild.sbt b/webapi/WebapiBuild.sbt index 33938c981d..82c823c72c 100644 --- a/webapi/WebapiBuild.sbt +++ b/webapi/WebapiBuild.sbt @@ -10,7 +10,7 @@ connectInput in run := true lazy val webApiCommonSettings = Seq( organization := "org.knora", name := "webapi", - version := "1.7.1", + version := "2.0.0", scalaVersion := "2.12.4" )