[SEBA-492] Upgrading documentation for xos-migrate
Change-Id: Ib584c15347bbca2c543ea83b1c96c74840e62605
diff --git a/VERSION b/VERSION
index fa27025..429988a 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-2.1.52
+2.1.53
diff --git a/containers/chameleon/Dockerfile.chameleon b/containers/chameleon/Dockerfile.chameleon
index 3aaa826..b39963f 100644
--- a/containers/chameleon/Dockerfile.chameleon
+++ b/containers/chameleon/Dockerfile.chameleon
@@ -13,7 +13,7 @@
# limitations under the License.
# xosproject/chameleon
-FROM xosproject/xos-base:2.1.52
+FROM xosproject/xos-base:2.1.53
# xos-base already has protoc and dependencies installed
diff --git a/containers/xos/Dockerfile.client b/containers/xos/Dockerfile.client
index 2ebab67..309cbc3 100644
--- a/containers/xos/Dockerfile.client
+++ b/containers/xos/Dockerfile.client
@@ -13,7 +13,7 @@
# limitations under the License.
# xosproject/xos-client
-FROM xosproject/xos-libraries:2.1.52
+FROM xosproject/xos-libraries:2.1.53
# Install XOS client
diff --git a/containers/xos/Dockerfile.libraries b/containers/xos/Dockerfile.libraries
index 28a1ec8..490b9a8 100644
--- a/containers/xos/Dockerfile.libraries
+++ b/containers/xos/Dockerfile.libraries
@@ -13,7 +13,7 @@
# limitations under the License.
# xosproject/xos-libraries
-FROM xosproject/xos-base:2.1.52
+FROM xosproject/xos-base:2.1.53
# Add libraries
COPY lib /opt/xos/lib
diff --git a/containers/xos/Dockerfile.synchronizer-base b/containers/xos/Dockerfile.synchronizer-base
index ab39a43..723687d 100644
--- a/containers/xos/Dockerfile.synchronizer-base
+++ b/containers/xos/Dockerfile.synchronizer-base
@@ -13,7 +13,7 @@
# limitations under the License.
# xosproject/xos-synchronizer-base
-FROM xosproject/xos-client:2.1.52
+FROM xosproject/xos-client:2.1.53
COPY xos/synchronizers/new_base /opt/xos/synchronizers/new_base
COPY xos/xos/logger.py /opt/xos/xos/logger.py
diff --git a/containers/xos/Dockerfile.xos-core b/containers/xos/Dockerfile.xos-core
index e9bbd14..b793f9a 100644
--- a/containers/xos/Dockerfile.xos-core
+++ b/containers/xos/Dockerfile.xos-core
@@ -13,7 +13,7 @@
# limitations under the License.
# xosproject/xos-core
-FROM xosproject/xos-libraries:2.1.52
+FROM xosproject/xos-libraries:2.1.53
# Install XOS
ADD xos /opt/xos
diff --git a/docs/dev/xosmigrate.md b/docs/dev/xosmigrate.md
index b5d4352..57490f2 100644
--- a/docs/dev/xosmigrate.md
+++ b/docs/dev/xosmigrate.md
@@ -24,8 +24,7 @@
The `xos-migrate` command is now available and you can see the options by running:
```bash
-xos-migrate -h
-usage: xos-migrate [-h] -s SERVICE_NAMES [-r REPO_ROOT] [-v]
+usage: xos-migrate [-h] -s SERVICE_NAMES [-r REPO_ROOT] [--check] [-v]
XOS Migrations
@@ -34,6 +33,8 @@
-r REPO_ROOT, --repo REPO_ROOT
The location of the folder containing the CORD repo
root (default to ~/cord)
+ --check Check if the migrations are generated for a given
+ service. Does not apply any change.
-v, --verbose increase log verbosity
required arguments:
@@ -153,3 +154,12 @@
However, in order to maintain clarity, we suggest to submit a single migration as part of a patch.
To do that you can simply remove all the migrations you have generated as part of your development and run the
`xos-migrate` tool again. This will generate a single migration file for all your changes.
+
+## Validate migration status
+
+Once you are done with development you want to make sure that all the necessary migrations are generated and checked in.
+To do that you can run the `xos-migrate` tool using the `--check` flag. Here is an example:
+
+```shell
+xos-migrate -s fabric --check
+```
\ No newline at end of file