git-version-bump 0.18.0.8.g580160f → 0.18.0.13.gc1af65c

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63fc7b28285b00549b449412a047a9abfddcde7f3306c8fd17285b97616c51d3
-  data.tar.gz: 8bc1c9a5e33b285602f28f49d24e16ab747b9e9556bc239c364f5236fbb733c2
+  metadata.gz: 401c8af39ee5870527618010dfaf9d40942dadf75be49d8aff1052068f26e05b
+  data.tar.gz: '050811bc1eecc11587c369fe2d1ad48d8f51291127cfd989d23202dca5758e67'
 SHA512:
-  metadata.gz: b986ba7470d40aee830db38aceb0581e23ee53e122371101b5625a90053d2df73c7d466329c5eb8070f07fc959b4dc966d013a72572fc9434d6d6afa0c482529
-  data.tar.gz: 981aac0343a8c43810dbc1725c68f192eef26706bab0f6e59cda1383fa17167e9e0c26e78d57c9efd738501a795fa5b36914ba5fc1e01b35ded8a8b8116c377c
+  metadata.gz: 388a339b6f4c4b12bab2294e7fd8c912c5385d50fcb26a504b1dd1266151eb7a34a9ebdccdca4c26cd2a508e898265d5a5389f46b0d56674761349214abfc933
+  data.tar.gz: 227415d087e67252ab3a89c655b2b1ffdb23b384f010b9355fa69f3a6f6b18e865764348cbed7a64ad4e949afa6b54ccc14a69b05d1dd82fa3dc25a5e16be890

data/README.md

@@ -141,6 +141,19 @@ commits to be detected then use the following configuration:
     end
 
 
+## Overriding the version
+
+In very rare circumstances, while running in a git repo, you may wish to explicitly set the version or date returned by `GVB.version` or `GVB.date`, respectively.
+This can be done by setting the repo's `versionBump.versionOverride` or `versionBump.dateOverride` config values, like so:
+
+```bash
+git config versionBump.versionOverride 1.2.3
+git config versionBump.dateOverride 1970-01-01
+```
+
+Note that whatever you set those values to is used without validity checking; if you set it to something weird, you'll get weird results.
+
+
 # Contributing
 
 Send your pull requests to the [Github

data/lib/git-version-bump.rb

@@ -25,7 +25,7 @@ module GitVersionBump
 			repo_version(true, include_lite_tags)
 		else
 			gem_version || repo_version(false, include_lite_tags)
-		end
+		end.tap { |v| p :GVB_VERSION, v if debug? }
 	end
 
 	def self.major_version(use_local_dir=false, include_lite_tags=false)
@@ -106,7 +106,7 @@ module GitVersionBump
 				log_file.close
 
 				pre_hash = Digest::SHA1.hexdigest(File.read(log_file.path))
-				run_command(["git", "config", "-e", "-f", log_file.path], "editing release notes")
+				run_command(["git", "config", "-e", "-f", log_file.path], "editing release notes", false)
 				if Digest::SHA1.hexdigest(File.read(log_file.path)) == pre_hash
 					puts "Release notes not edited; not making release"
 					log_file.unlink
@@ -198,10 +198,10 @@ module GitVersionBump
 
 	# Execute a command, specified as an array.
 	#
-	# On success, the full output of the command (stdout+stderr, interleaved) is returned.
+        # On success, the full output of the command (stdout+stderr, interleaved) is returned unless capture_output is not true.
 	# On error, a `CommandFailure` exception is raised.
 	#
-	def self.run_command(cmd, desc)
+	def self.run_command(cmd, desc, capture_output = true)
 		unless cmd.is_a?(Array)
 			raise ArgumentError, "Must pass command line arguments in an array"
 		end
@@ -214,7 +214,13 @@ module GitVersionBump
 			p :GVB_CMD, desc, cmd
 		end
 
-		out, status = Open3.capture2e({"LC_MESSAGES" => "C"}, *cmd)
+		if capture_output == true
+			out, status = Open3.capture2e({"LC_MESSAGES" => "C"}, *cmd)
+		else
+			out = '(output not captured)'
+			pid = spawn(*cmd)
+			(retpid, status) = Process.wait2 pid
+		end
 
 		if status.exitstatus != 0
 			raise CommandFailure.new("Failed while #{desc}", out, status.exitstatus)
@@ -236,6 +242,11 @@ module GitVersionBump
 	end
 	private_class_method :try_command
 
+	def self.run_git(git_args, desc, use_local_dir)
+		run_command(["git", "-C", git_dir(use_local_dir).to_s] + git_args, desc)
+	end
+	private_class_method :run_git
+
 	def self.caller_file
 		# Who called us?  Because this method gets called from other methods
 		# within this file, we can't just look at Gem.location_of_caller, but
@@ -298,6 +309,16 @@ module GitVersionBump
 	private_class_method :gem_version
 
 	def self.repo_version(use_local_dir, include_lite_tags)
+		begin
+			run_git(["config", "versionBump.versionOverride"], "getting versionOverride", use_local_dir).chomp
+		rescue CommandFailure => ex
+			p :NO_OVERRIDE_VERSION, [ex.class, ex.message] if debug?
+			repo_version_from_tag(use_local_dir, include_lite_tags)
+		end
+	end
+	private_class_method :repo_version
+
+	def self.repo_version_from_tag(use_local_dir, include_lite_tags)
 		git_cmd = ["git", "-C", git_dir(use_local_dir).to_s, "describe", "--dirty=.1.dirty.#{Time.now.strftime("%Y%m%d.%H%M%S")}", "--match=#{VERSION_TAG_GLOB}"]
 		git_cmd << "--tags" if include_lite_tags
 
@@ -316,9 +337,19 @@ module GitVersionBump
 			end
 		end
 	end
-	private_class_method :repo_version
+	private_class_method :repo_version_from_tag
 
 	def self.repo_date(use_local_dir, include_lite_tags)
+		begin
+			run_git(["config", "versionBump.dateOverride"], "getting dateOverride", use_local_dir).chomp
+		rescue CommandFailure => ex
+			p :NO_OVERRIDE_DATE, [ex.class, ex.message] if debug?
+			repo_date_from_commit(use_local_dir, include_lite_tags)
+		end
+	end
+	private_class_method :repo_date
+
+	def self.repo_date_from_commit(use_local_dir, include_lite_tags)
 		if dirty_tree?(git_dir(use_local_dir))
 			Time.now.strftime("%F")
 		else
@@ -328,7 +359,7 @@ module GitVersionBump
 	rescue CommandFailure
 		raise VersionUnobtainable, "Could not get commit date from git repository at #{git_dir(use_local_dir)}"
 	end
-	private_class_method :repo_date
+	private_class_method :repo_date_from_commit
 
 	def self.git_dir(use_local_dir = false)
 		if use_local_dir

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git-version-bump
 version: !ruby/object:Gem::Version
-  version: 0.18.0.8.g580160f
+  version: 0.18.0.13.gc1af65c
 platform: ruby
 authors:
 - Matt Palmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-20 00:00:00.000000000 Z
+date: 2023-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-release