Added version number header to all doc pages

jgebal · jgebal · commit 06fb132291e8 · 2019-03-15T13:44:43.000Z
Added update of version number in doc pages
diff --git a/.travis/update_project_version.sh b/.travis/update_project_version.sh
@@ -6,6 +6,9 @@ echo Update version in project source files
 find ${UTPLSQL_SOURCES_DIR} -type f -name '*' -exec sed -i -r "s/${UTPLSQL_VERSION_PATTERN}/${UTPLSQL_BUILD_VERSION}/" {} \;
 echo Source files updated with version tag: ${UTPLSQL_BUILD_VERSION}
 
+echo Update version in documentation files
+find docs -type f -name '*.md' -exec sed -i -r "s/(badge\/version-).*(-blue\.svg)/\1${UTPLSQL_BUILD_VERSION/-/--}\2/" {} \;
+
 echo Update of sonar-project.properties sonar.projectVersion
 sed -i -r "s/(sonar\.projectVersion=).*?/\1${UTPLSQL_VERSION}/" sonar-project.properties
 
diff --git a/docs/about/authors.md b/docs/about/authors.md
@@ -1,3 +1,4 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
 
 ### utPLSQL v3 Major Contributors 
 
diff --git a/docs/about/license.md b/docs/about/license.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Version Information
 
 **utPLSQL version 3** is licensed under 
diff --git a/docs/about/project-details.md b/docs/about/project-details.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # utPLSQL Project Details
 
 [![chat](http://img.shields.io/badge/GitHub_Project-Active-blue.svg)](https://github.com/utPLSQL/utPLSQL)
diff --git a/docs/about/support.md b/docs/about/support.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # How to get support
 
 - Feel free to post questions, bugs or issues in the [issues area of GitHub](https://github.com/utPLSQL/utPLSQL/issues)
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Introduction to utPLSQL
 
 utPLSQL is a Unit Testing framework for Oracle PL/SQL.
diff --git a/docs/userguide/advanced_data_comparison.md b/docs/userguide/advanced_data_comparison.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Advanced data comparison
 
 utPLSQL expectations incorporates advanced data comparison options when comparing compound data-types:
diff --git a/docs/userguide/annotations.md b/docs/userguide/annotations.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Annotations
 
 Annotations are used to configure tests and suites in a declarative way similar to modern OOP languages. This way, test configuration is stored along with the test logic inside the test package.
diff --git a/docs/userguide/best-practices.md b/docs/userguide/best-practices.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Best Practices
 
 The following are best practices we at utPLSQL have learned about PL/SQL and Unit Testing. 
diff --git a/docs/userguide/coverage.md b/docs/userguide/coverage.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Coverage
 utPLSQL comes with a built-in coverage reporting engine. The code coverage reporting is based on the DBMS_PROFILER package provided with Oracle database.
 Code coverage is gathered for the following source types:
diff --git a/docs/userguide/exception-reporting.md b/docs/userguide/exception-reporting.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Exception handling and reporting
 
 The utPLSQL is responsible for handling exceptions wherever they occur in the test run. utPLSQL is trapping most of the exceptions so that the test execution is not affected by individual tests or test packages throwing an exception.
diff --git a/docs/userguide/expectations.md b/docs/userguide/expectations.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Expectation concepts 
 Validation of the code under test (the tested logic of procedure/function etc.) is performed by comparing the actual data against the expected data.
 utPLSQL uses a combination of expectation and matcher to perform the check on the data.
diff --git a/docs/userguide/getting-started.md b/docs/userguide/getting-started.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Getting started with TDD and utPLSQL
 
 utPLSQL is designed in a way that allows you to follow 
diff --git a/docs/userguide/install.md b/docs/userguide/install.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Downloading latest version of utPLSQL
 
 To download latest version of utPLSQL from github on both Unix/Linux as well as Windows machines use the below smippets.
diff --git a/docs/userguide/querying_suites.md b/docs/userguide/querying_suites.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Qyerying for test suites
 
 
diff --git a/docs/userguide/reporters.md b/docs/userguide/reporters.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 utPLSQL provides the following reporting formats.
 
 # Documentation reporter
diff --git a/docs/userguide/running-unit-tests.md b/docs/userguide/running-unit-tests.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Running tests
 
 utPLSQL framework provides two main entry points to run unit tests from within the database: 
diff --git a/docs/userguide/upgrade.md b/docs/userguide/upgrade.md
@@ -1,3 +1,5 @@
+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)
+
 # Upgrading from version 2
 
 utPLSQL v3 is a total rewrite of the framework.

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)`
`1`	`2`
`2`	`3`	`### utPLSQL v3 Major Contributors`
`3`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)`
	`2`	`+`
`1`	`3`	`# Version Information`
`2`	`4`
`3`	`5`	`utPLSQL version 3 is licensed under`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)`
	`2`	`+`
`1`	`3`	`# utPLSQL Project Details`
`2`	`4`
`3`	`5`	`[![chat](http://img.shields.io/badge/GitHub_Project-Active-blue.svg)](https://github.com/utPLSQL/utPLSQL)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)`
	`2`	`+`
`1`	`3`	`# How to get support`
`2`	`4`
`3`	`5`	`- Feel free to post questions, bugs or issues in the [issues area of GitHub](https://github.com/utPLSQL/utPLSQL/issues)`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)`
	`2`	`+`
`1`	`3`	`# Introduction to utPLSQL`
`2`	`4`
`3`	`5`	`utPLSQL is a Unit Testing framework for Oracle PL/SQL.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)`
	`2`	`+`
`1`	`3`	`# Advanced data comparison`
`2`	`4`
`3`	`5`	`utPLSQL expectations incorporates advanced data comparison options when comparing compound data-types:`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)`
	`2`	`+`
`1`	`3`	`# Annotations`
`2`	`4`
`3`	`5`	`Annotations are used to configure tests and suites in a declarative way similar to modern OOP languages. This way, test configuration is stored along with the test logic inside the test package.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)`
	`2`	`+`
`1`	`3`	`# Best Practices`
`2`	`4`
`3`	`5`	`The following are best practices we at utPLSQL have learned about PL/SQL and Unit Testing.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+![version](https://img.shields.io/badge/version-v3.1.4.2223--develop-blue.svg)`
	`2`	`+`
`1`	`3`	`# Coverage`
`2`	`4`	`utPLSQL comes with a built-in coverage reporting engine. The code coverage reporting is based on the DBMS_PROFILER package provided with Oracle database.`
`3`	`5`	`Code coverage is gathered for the following source types:`