Merge pull request #248 from jgebal/feature/update_release_process

jgebal · web-flow · commit e14739ef8cae · 2017-03-29T01:21:12.000+01:00
Update of the release process to make it update version of project files
diff --git a/.gitattributes b/.gitattributes
@@ -1,10 +1,2 @@
-.gitattributes            export-ignore
-.gitignore                export-ignore
-.gitmodules               export-ignore
-.travis.yml               export-ignore
-mkdocs.yml                export-ignore
-.travis                   export-ignore
-sonar-project.properties  export-ignore
-^tests/*                  export-ignore
-^development/*            export-ignore
-^docs/*        linguist-documentation
+*            export-ignore
+^docs/*      linguist-documentation
diff --git a/.gitattributes.release b/.gitattributes.release
@@ -0,0 +1,11 @@
+.gitattributes            export-ignore
+.gitignore                export-ignore
+.gitmodules               export-ignore
+.travis.yml               export-ignore
+mkdocs.yml                export-ignore
+.travis                   export-ignore
+sonar-project.properties  export-ignore
+tests                     export-ignore
+development               export-ignore
+node_modules              export-ignore
+^docs/*                   linguist-documentation
diff --git a/.gitignore b/.gitignore
@@ -10,3 +10,4 @@ pages/
 release/
 *.gz
 *.zip
+node_modules/
diff --git a/.travis.yml b/.travis.yml
@@ -25,6 +25,15 @@ env:
     - UT3_USER=ut3_user
     - UT3_USER_PASSWORD=ut3
     - UT3_TABLESPACE=users
+    # Environment for building a release
+    - CURRENT_BRANCH=${TRAVIS_BRANCH}
+    - UTPLSQL_REPO="utPLSQL/utPLSQL"
+    - UTPLSQL_BUILD_NO="${TRAVIS_BUILD_NUMBER:-0}"
+    - UTPLSQL_VERSION_PLACEHOLDER='utPLSQL - Version'
+    - UTPLSQL_VERSION=$(. .travis/get_project_version.sh)
+    - UTPLSQL_BUILD_VERSION=$(. .travis/get_project_build_version.sh)
+    - UTPLSQL_SOURCES_DIR='source'
+    - UTPLSQL_BUILD_USER_NAME="Travis CI"
     # Target Branch and Directory for Deployment of Docs
     - PAGES_TARGET_BRANCH="gh-pages"
     - PAGES_VERSION_BASE="version3"
@@ -48,27 +57,39 @@ install:
   - bash .travis/install_sqlcl.sh
   - sudo mkdir -p /dev/pdbs
   - sudo chmod -R 777 /dev/pdbs
-  - bash .travis/start_db.sh
+  - if [ "${TRAVIS_TAG}" = "" ]; then bash .travis/start_db.sh; fi
+
+before_script:
+  #The update_project_version is done before deployment to validate that the change of project files does not break installation
+  - bash .travis/update_project_version.sh
+  - git config --global user.email "builds@travis-ci.com"
+  - git config --global user.name "${UTPLSQL_BUILD_USER_NAME}"
+  - git remote rm origin
+  - git remote add origin https://${github_api_token}@github.com/${UTPLSQL_REPO}
 
 script:
-  - bash .travis/install.sh
-  - bash .travis/run_examples_and_tests.sh
-#  - bash .travis/run_test_as_user.sh
-#  - bash .travis/build_docs.sh
-#  - bash .travis/push_docs_to_gh_pages.sh
-  - sonar-scanner
-  - bash .travis/coveralls_uploader.sh
+  - if [ "${TRAVIS_TAG}" = "" ]; then bash .travis/install.sh; fi
+  - if [ "${TRAVIS_TAG}" = "" ]; then bash .travis/run_examples_and_tests.sh; fi
+  - if [ "${TRAVIS_TAG}" = "" ]; then sonar-scanner; fi
+  - if [ "${TRAVIS_TAG}" = "" ]; then bash .travis/coveralls_uploader.sh; fi
+  - bash .travis/build_docs.sh
+  - if [ "${TRAVIS_TAG}" = "" ]; then bash .travis/push_release_version.sh; fi
+
+before_deploy:
+  - bash .travis/build_release_archive.sh
 
 deploy:
   provider: releases
   api_key: $github_api_token
   file:
-     - utPLSQL$TRAVIS_TAG.zip
-     - utPLSQL$TRAVIS_TAG.tar.gz
+     - utPLSQL${UTPLSQL_BUILD_VERSION}.zip
+     - utPLSQL${UTPLSQL_BUILD_VERSION}.tar.gz
   skip_cleanup: true
   on:
-     repo: utPLSQL/utPLSQL
+     repo: ${UTPLSQL_REPO}
      tags: true
+     # when building from a release tag, use only first job "#xxx.1" to publish artifacts
+     condition: "${TRAVIS_JOB_NUMBER} =~ \\.1$"
 
 notifications:
   slack: utplsql:oiMuXO95TvKeAUENuDt4cPrB
diff --git a/.travis/build_release_archive.sh b/.travis/build_release_archive.sh
@@ -0,0 +1,10 @@
+#!/bin/bash
+
+mv -f .gitattributes.release .gitattributes
+git add .
+git commit -m "tmp commit for building a release archive"
+
+git archive --prefix="utPLSQL${UTPLSQL_BUILD_VERSION}"/ -o "utPLSQL${UTPLSQL_BUILD_VERSION}".zip    --format=zip    HEAD
+git archive --prefix="utPLSQL${UTPLSQL_BUILD_VERSION}"/ -o "utPLSQL${UTPLSQL_BUILD_VERSION}".tar.gz --format=tar.gz HEAD
+
+
diff --git a/.travis/create_release.sh b/.travis/create_release.sh
diff --git a/.travis/create_release_archive.sh b/.travis/create_release_archive.sh
diff --git a/.travis/get_project_build_version.sh b/.travis/get_project_build_version.sh
@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+echo `sed -r "s/(v?[0-9]+\.)([0-9]+\.)([0-9]+)(-.*)/\1\2\3\.${UTPLSQL_BUILD_NO}\4/" <<< "${UTPLSQL_VERSION}"`
diff --git a/.travis/get_project_version.sh b/.travis/get_project_version.sh
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+#If building a new version from a release branch - then version is taken from release branch name
+if [[ "${CURRENT_BRANCH}" =~ ^release/v[0-9]+\.[0-9]+\.[0-9]+.*$ ]]; then
+  version=${CURRENT_BRANCH#release\/}
+elif [[ "${TRAVIS_TAG}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+.*$ ]]; then
+  version=${TRAVIS_TAG}
+else
+  version=`cat VERSION`
+fi
+echo ${version}
diff --git a/.travis/install_libraries.sh b/.travis/install_libraries.sh
diff --git a/.travis/push_release_version.sh b/.travis/push_release_version.sh
@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+echo Current branch is "${CURRENT_BRANCH}"
+if [[ "${CURRENT_BRANCH}" =~ ^release/v[0-9]+\.[0-9]+\.[0-9]+.*$ ]]; then
+
+    echo Current job number is "${TRAVIS_JOB_NUMBER}"
+    if [[ "${TRAVIS_JOB_NUMBER}" =~ \.1$ ]]; then
+        echo Publishing will be done for a job no. "${TRAVIS_JOB_NUMBER}"
+        git add sonar-project.properties
+        git add VERSION
+        git commit -m 'Updated project version after building a release [skip ci]'
+
+        echo Pushing to origin
+        git push --quiet origin HEAD:${CURRENT_BRANCH}
+    else
+        echo Publishing will not be done for a job no.: "${TRAVIS_JOB_NUMBER}"
+    fi
+else
+    echo Not on a release branch - skipping publishing of version
+fi
diff --git a/.travis/update_project_version.sh b/.travis/update_project_version.sh
@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+echo Current branch is "${CURRENT_BRANCH}"
+
+echo Update version in project source files
+find ${UTPLSQL_SOURCES_DIR} -type f -name '*' -exec sed -i -r "s/(${UTPLSQL_VERSION_PLACEHOLDER} )[^']*(')?/\1${UTPLSQL_BUILD_VERSION}\2/" {} \;
+echo Source files updated with version tag: ${UTPLSQL_BUILD_VERSION}
+
+echo Update of sonar-project.properties sonar.projectVersion
+sed -i -r "s/(sonar\.projectVersion=).*?/\1${UTPLSQL_VERSION}/" sonar-project.properties
+
+echo Update VERSION file
+echo ${UTPLSQL_VERSION} > VERSION
+
diff --git a/VERSION b/VERSION
@@ -0,0 +1 @@
+3.0.0.Alpha
diff --git a/development/readme.md b/development/readme.md
@@ -1,4 +1,4 @@
-#Build Folder
+# Build Folder
 
  Contains the build scripts that can be run locally on a developers machine to build run and test utPLSQL.  
 
diff --git a/development/releasing.md b/development/releasing.md
@@ -0,0 +1,11 @@
+Release process is automated in following way:
+1) with every build, the build process on travis updatse files with appropriate version number before deployment into db.
+   This is to confirm that the update of versions works properly.
+2) when build is executed on a branch named `release/v1.2.3-something` then additional steps are taken:
+    - project version in files: `sonar-project.properties`, `VERSION` is updated from the version number derived from release branch
+    - changes on those two files are committed and and pushed - this should happen only once, when the release branch is initially created on the main repo
+3) To create a release, just create a tag on the code to be released. The tag name must match the regex pattern: `^v[0-9]+\.[0-9]+\.[0-9]+.*$`
+   - When a tag build is executed, the documentation is built and files are uploaded to the tag.
+   - The version number is derived from the tag name.
+4) Release version do not provide access to unversioned source files (the default zip file from github is empty). 
+   The sources for release are provided in separate zip files delivered from travis build process.
diff --git a/source/api/ut.pkb b/source/api/ut.pkb
@@ -17,6 +17,11 @@ create or replace package body ut is
   limitations under the License.
   */
 
+  function version return varchar2 is
+  begin
+    return ut_utils.gc_version;
+  end;
+
   function expect(a_actual in anydata, a_message varchar2 := null) return ut_expectation_anydata is
   begin
     return ut_expectation_anydata(ut_data_value_anydata(a_actual), a_message);
diff --git a/source/api/ut.pks b/source/api/ut.pks
@@ -17,6 +17,8 @@ create or replace package ut authid current_user as
   limitations under the License.
   */
 
+  function version return varchar2;
+
   function expect(a_actual in anydata, a_message varchar2 := null) return ut_expectation_anydata;
 
   function expect(a_actual in blob, a_message varchar2 := null) return ut_expectation_blob;
diff --git a/source/api/ut_runner.pkb b/source/api/ut_runner.pkb
@@ -17,6 +17,11 @@ create or replace package body ut_runner is
   limitations under the License.
   */
 
+  function version return varchar2 is
+  begin
+    return ut_utils.gc_version;
+  end;
+
   procedure run(a_paths ut_varchar2_list, a_reporters ut_reporters, a_color_console boolean := false) is
     l_items_to_run  ut_run;
     l_listener      ut_event_listener;
diff --git a/source/api/ut_runner.pks b/source/api/ut_runner.pks
@@ -17,6 +17,8 @@ create or replace package ut_runner authid current_user is
   limitations under the License.
   */
 
+  function version return varchar2;
+
   /**
   * Run suites/tests by path
   * Accepts value of the following formats:
diff --git a/source/core/ut_utils.pks b/source/core/ut_utils.pks
@@ -22,6 +22,7 @@ create or replace package ut_utils authid definer is
 
   */
 
+  gc_version                 constant varchar2(50) := 'utPLSQL - Version X.X.X.X';
 
   /* Constants: Event names */
   gc_run                     constant varchar2(12) := 'run';
diff --git a/source/reporters/ut_coverage_report_html_helper.pkb b/source/reporters/ut_coverage_report_html_helper.pkb
@@ -16,7 +16,6 @@ create or replace package body ut_coverage_report_html_helper is
   limitations under the License.
   */
 
-  gc_version             constant varchar2(50) := '3.0.0.0-Alpha-1';
   gc_green_coverage_pct  constant integer      := 90;
   gc_yellow_coverage_pct constant integer      := 80;
 
@@ -244,7 +243,7 @@ create or replace package body ut_coverage_report_html_helper is
     l_file_part :=
      chr(10)||
      '</div><div id="footer">' ||
-     'Generated by <a href="http://github.com/utPLSQL/utPLSQL">utPLSQL</a> v'||gc_version||'<br/>' ||
+     'Generated by <a href="http://github.com/utPLSQL/utPLSQL">'||ut_utils.gc_version||'</a><br/>' ||
      'Based on <a href="http://github.com/colszowka/simplecov-html">simplecov-html</a> v0.10.0 '||l_using||'' ||
      '</div><div class="source_files">';
     dbms_lob.writeappend(l_result, length(l_file_part), l_file_part);

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+#!/usr/bin/env bash`
	`2`	+echo `sed -r "s/(v?[0-9]+\.)([0-9]+\.)([0-9]+)(-.*)/\1\2\3\.${UTPLSQL_BUILD_NO}\4/" <<< "${UTPLSQL_VERSION}"`