From 57f4898c9ce137755c2cc3dca44ee935919fbffc Mon Sep 17 00:00:00 2001 From: Jacek Date: Tue, 29 Aug 2017 07:59:19 +0100 Subject: [PATCH] Updated description of release process in `releasing.md` --- development/releasing.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/development/releasing.md b/development/releasing.md index ece04df65..44fe4914c 100644 --- a/development/releasing.md +++ b/development/releasing.md @@ -1,11 +1,20 @@ -The release process is automated in the following way: -1) With every build, the build process on Travis updates files with an appropriate version number before deployment into the database. - This is to confirm that the update of versions works properly. -2) When a build is executed on a branch named `release/v1.2.3-something` then additional steps are taken: - - the project version in files: `sonar-project.properties`, `VERSION` is updated from the version number derived from the release branch - - changes to those two files are committed 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) The release version does 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 the Travis build process. +The release process is semi-automated. + +With every build, the build process on Travis updates files with an appropriate version number before deployment into the database. +This step is performed, to confirm that the update of versions works properly. + +To create a release: + - create release branch and wait for release build to complete successfully + - merge release branch to master and wait for master build to complete successfully + - create a release from the master branch using github web page and populate release description using information found on the issues and pull requests for release + +The following will happen: + - build executed on branch `release/v1.2.3-[something]` updates files `sonar-project.properties`, `VERSION` with project version derived from the release branch name + - changes to those two files are committed and pushed back to release branch by Travis + - when a release is created, a new tag is added in on the repository and a tag build is executed + - the documentation for new release is published on `utplsql.github.io` and installation archives are added to the tag. + +Note: +The released version does not provide access to un-versioned source files (the default zip file from GitHub is empty). +The sources for release are provided in separate zip files delivered from the Travis build process. +This is because we do not keep version in our source files in develop branch.