Release 0.0.2

- Update version number.
- Update generate release instructions.

Author: dmg0345

doc/conf.py

@@ -29,7 +29,7 @@
 # Project copyright.
 copyright = author
 # Project version.
-version = "0.0.0"
+version = "0.0.2"
 # Project release, set it as the same value as version as the separation is not required.
 release = version
 

doc/version/index.rst

@@ -15,3 +15,5 @@ Version
 .. doxygenvariable:: Utils::Version::DESCRIPTION
 
 .. doxygenvariable:: Utils::Version::VERSION
+
+.. doxygenvariable:: Utils::Version::COMMIT_HASH

other/cmake/tag.cmake

@@ -6,10 +6,10 @@
 file(GLOB_RECURSE PROJECT_SOURCE_FILES
     "${PROJECT_ROOT_DIR}/src/*.cpp"
     "${PROJECT_ROOT_DIR}/src/*.hpp"
+    "${PROJECT_ROOT_DIR}/src/*.fidl"
+    "${PROJECT_ROOT_DIR}/src/*.fdepl"
     "${PROJECT_ROOT_DIR}/tests/tests/*.cpp"
     "${PROJECT_ROOT_DIR}/tests/tests/*.hpp"
-    "${PROJECT_ROOT_DIR}/third_party/*.fidl"
-    "${PROJECT_ROOT_DIR}/third_party/*.fdepl"
 )
 
 # Check if tagging filenames only.

other/cmake/version.cmake

@@ -8,9 +8,9 @@ set(PROJECT_CONTACT "dmg0345@gmail.com")
 set(PROJECT_URL "https://github.com/dmg0345/commonapi_cpp_examples")
 set(PROJECT_DESCRIPTION "Common API C++ Examples")
 set(PROJECT_COPYRIGHT "github.com/dmg0345/commonapi_cpp_examples/blob/master/LICENSE")
-set(PROJECT_VERSION_MAJOR "1")
+set(PROJECT_VERSION_MAJOR "0")
 set(PROJECT_VERSION_MINOR "0")
-set(PROJECT_VERSION_PATCH "0")
+set(PROJECT_VERSION_PATCH "2")
 set(PROJECT_VERSION "${PROJECT_VERSION_MAJOR}.${PROJECT_VERSION_MINOR}.${PROJECT_VERSION_PATCH}")
 string(TIMESTAMP PROJECT_BUILD_TIMESTAMP_UTC "%d-%m-%Y %H:%M:%S (UTC)" UTC)
 

readme.rst

@@ -35,9 +35,11 @@ Create a release
 
 To generate a release follow the steps below:
 
-1. Create a ``release`` branch from ``develop`` branch, e.g. ``release/X.Y.Z``.
-2. Update version in *conf.py* file and in *version.cmake* file.
-3. Run *cmake* with ``-DCFG_TAG:BOOL=ON`` to tag all the relevant files.
-4. Create pull request from ``release`` branch to ``master`` with the changes with title *Release X.Y.Z*.
-5. When merged in ``master`` create release and tag from *Github*, review production workflow passes for deployment.
-6. Delete the ``release/X.Y.Z`` branch.
+1. Create a ``release`` branch from ``develop`` branch named ``release/X.Y.Z``.
+2. Update version in *conf.py* file and in *version.cmake* file, commit change to ``release/X.Y.Z`` branch.
+3. Create branch called ``release/X.Y.Z_tag`` from ``release/X.Y.Z``
+4. On branch ``release/X.Y.Z_tag``, run *cmake* with ``-DCFG_TAG:BOOL=ON`` to tag all files, and commit the changes.
+5. Create pull request from ``release/X.Y.Z_tag`` branch to ``master`` branch, with the title *Release X.Y.Z*.
+6. Create pull request from ``release/X.Y.Z`` branch to ``develop`` branch, with the title *Release X.Y.Z*.
+7. When merged in ``master`` create release and tag from *Github* from merged commit, review production workflow passes.
+8. Delete the ``release/X.Y.Z_tag`` branch, keep the ``release/X.Y.Z`` branch, which holds the commit hash tagged.