Merge pull request #201 from cyberark/automated-release-process

ONYX-14702: Update to use automated release process

Author: ismarc

CHANGELOG.md

@@ -4,11 +4,17 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## Unreleased
+### Changed
+- Nothing should go in this section, please add to the latest unreleased version
+  (and update the corresponding date), or add a new version.
+
+## [5.3.7] - 2021-12-28
 
 ### Changed
 - Change addressable gem dependency.
   [cyberark/conjur-api-ruby#199](https://github.com/cyberark/conjur-api-ruby/pull/199)
+- Update to use automated release process
 
 ## [5.3.6] - 2021-12-09
 
@@ -357,6 +363,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [2.0.0] - 2013-13-12
 
 [Unreleased]: https://github.com/cyberark/conjur-api-ruby/compare/v5.3.6...HEAD
+[5.3.7]: https://github.com/cyberark/conjur-api-ruby/compare/v5.3.6...v5.3.7
 [5.3.6]: https://github.com/cyberark/conjur-api-ruby/compare/v5.3.5...v5.3.6
 [5.3.5]: https://github.com/cyberark/conjur-api-ruby/compare/v5.3.4...v5.3.5
 [5.3.4]: https://github.com/cyberark/conjur-api-ruby/compare/v5.3.3...v5.3.4

Dockerfile

@@ -5,7 +5,7 @@ RUN apt-get update && apt-get install -y vim curl
 
 WORKDIR /src/conjur-api
 
-COPY Gemfile conjur-api.gemspec ./
+COPY Gemfile conjur-api.gemspec VERSION ./
 COPY lib/conjur-api/version.rb ./lib/conjur-api/
 
 RUN bundle

Jenkinsfile

@@ -1,5 +1,17 @@
 #!/usr/bin/env groovy
 
+// Automated release, promotion and dependencies
+properties([
+  release.addParams()
+])
+
+if (params.MODE == "PROMOTE") {
+  release.promote(params.VERSION_TO_PROMOTE) { sourceVersion, targetVersion, assetDirectory ->
+    sh './publish.sh'
+  }
+  return
+}
+
 pipeline {
   agent { label 'executor-v2' }
 
@@ -12,9 +24,29 @@ pipeline {
     cron(getDailyCronString())
   }
 
+  environment {
+    MODE = release.canonicalizeMode()
+  }
+
   stages {
-    stage('Validate Changelog') {
-      steps { sh './bin/parse-changelog.sh' }
+    stage ("Skip build if triggering job didn't create a release") {
+      when {
+        expression {
+          MODE == "SKIP"
+        }
+      }
+      steps {
+        script {
+          currentBuild.result = 'ABORTED'
+          error("Aborting build because this build was triggered from upstream, but no release was built")
+        }
+      }
+    }
+    stage('Validate Changelog and set version') {
+      steps {
+        sh './bin/parse-changelog.sh'
+        updateVersion("CHANGELOG.md", "${BUILD_NUMBER}")
+      }
     }
 
     stage('Prepare CC Report Dir'){
@@ -107,23 +139,21 @@ pipeline {
       }
     }
 
-    // Only publish to RubyGems if the tag begins with 'v' ex) v5.3.2
-    stage('Publish to RubyGems?') {
-      agent { label 'executor-v2' }
+    stage('Release') {
+      when {
+        expression {
+          MODE == "RELEASE"
+        }
+      }
 
-      when { tag "v*" }
       steps {
-        // Clean up first
-        sh 'docker run -i --rm -v $PWD:/src -w /src alpine/git clean -fxd'
-
-        sh './publish.sh'
-
-        // Clean up again...
-        sh 'docker run -i --rm -v $PWD:/src -w /src alpine/git clean -fxd'
-        deleteDir()
+        release {
+          // Clean up all but the calculated VERSION
+          sh 'docker run -i --rm -v $PWD:/src -w /src alpine/git clean -fxd -e VERSION'
+          sh './publish.sh'
+        }
       }
     }
-
   }
 
   post {

conjur-api.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |gem|
   gem.homepage      = "https://github.com/cyberark/conjur-api-ruby/"
   gem.license       = "Apache-2.0"
 
-  gem.files         = `git ls-files`.split($\) + Dir['build_number']
+  gem.files         = `git ls-files`.split($\).append("VERSION") + Dir['build_number']
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "conjur-api"

lib/conjur-api/version.rb

@@ -19,6 +19,6 @@
 
 module Conjur
   class API
-    VERSION = "5.3.6"
+    VERSION = File.read(File.expand_path('../../VERSION', __dir__))
   end
 end