Migrate to a version.rb file for tracking version internally

stelligent · Oct 15, 2021 · e1cb0fc · e1cb0fc
1 parent d6193cb
commit e1cb0fc
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 5 deletions.
diff --git a/bin/cfn_nag_rules b/bin/cfn_nag_rules
@@ -6,7 +6,7 @@ require 'cfn-nag'
 require 'rubygems/specification'
 
 opts = Optimist.options do
-  version Gem::Specification.find_by_name('cfn-nag').version
+  version CfnNagVersion::VERSION
 
   opt :rule_directory, 'Extra rule directories', type: :io,
                                                  required: false,

diff --git a/cfn-nag.gemspec b/cfn-nag.gemspec
@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require_relative 'lib/cfn-nag/version'
+
 Gem::Specification.new do |s|
   s.name          = 'cfn-nag'
   s.license       = 'MIT'
-  s.version       = ENV['GEM_VERSION'] || '0.0.0'
+  s.version       = ENV['GEM_VERSION'] || CfnNagVersion::VERSION
   s.bindir        = 'bin'
   s.executables   = %w[cfn_nag cfn_nag_rules cfn_nag_scan spcm_scan]
   s.authors       = ['Eric Kascic']

diff --git a/lib/cfn-nag/cli_options.rb b/lib/cfn-nag/cli_options.rb
@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
 require 'optimist'
+require_relative 'version'
 
 # rubocop:disable Metrics/ClassLength
 class Options
   @custom_rule_exceptions_message = 'Isolate custom rule exceptions - just ' \
                                     'emit the exception without stack trace ' \
                                     'and keep chugging'
 
-  @version = Gem::Specification.find_by_name('cfn-nag').version
+  @version = CfnNagVersion::VERSION
 
   def self.for(type)
     case type

diff --git a/lib/cfn-nag/result_view/sarif_results.rb b/lib/cfn-nag/result_view/sarif_results.rb
@@ -35,7 +35,7 @@ def driver(rules)
     {
       name: 'cfn_nag',
       informationUri: 'https://github.com/stelligent/cfn_nag',
-      semanticVersion: Gem.loaded_specs['cfn-nag'].version.to_s,
+      semanticVersion: CfnNagVersion::VERSION,
       rules: rules.map do |rule_definition|
         {
           id: "CFN_NAG_#{rule_definition.id}",

diff --git a/lib/cfn-nag/version.rb b/lib/cfn-nag/version.rb
@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module CfnNagVersion
+  # This is managed at release time via scripts/publish.sh
+  VERSION = '0.0.0'
+end
diff --git a/scripts/publish.sh b/scripts/publish.sh
@@ -45,7 +45,7 @@ else
   new_version="${minor_version}.$((current_version+1))"
 fi
 
-sed -i.bak "s/0\.0\.0/${new_version}/g" cfn-nag.gemspec
+sed -i.bak "s/0\.0\.0/${new_version}/g" lib/cfn-nag/version.rb
 
 # publish rubygem to rubygems.org, https://rubygems.org/gems/cfn-nag
 gem build cfn-nag.gemspec