bake-gem 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56f25a569c1ad97d712dd23c2651d425f48934744ae1f93404109cfd5ca4df79
-  data.tar.gz: f3f4c84f836f42c1b25040dd72ae0f0fee003a3e74071aa0e471840edb130a20
+  metadata.gz: 73b07dbaea11129cd0e9022c476330602dbd3aeeec3fe69064bd365d20976665
+  data.tar.gz: 42675a6c56c29dd54e5a103a6eee4ca5e42febf8f93783ed1633fe9cb9438db6
 SHA512:
-  metadata.gz: db2c62ccb6a54db12070f212f61c17481c17fe4aa06f9da1724ed6a5aee48f3ce6392799589b0d1693de05789ebce4159a3f84efd503290ddd4ffd641d79676d
-  data.tar.gz: b24640b9579858b9f95b56040dfe47953a11c056c6460f15951a5cf2d5e23e4e4da64c9a5c2ffad4245b3af2dfb07fc3e8301cf44c12057accec94546f9a2dd1
+  metadata.gz: 99578f4c9aca82a9dda42e006b261f84858a6f282f7f725849af9c566e459e5490569f701b37c5ae1f083bcb414c9b32cd06bbf876a574fa52c71f26f9d741d9
+  data.tar.gz: fdd496e868dbf915ee81d7f11851cb274770792e39698785c32c38990af88e21b6d7a243f5f0f1a056cca84e1a8cfbd9b49279ecb61d6e541945c353fb6da144

data/bake/gem/release/branch.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative '../../../lib/bake/gem/shell'
 

data/bake/gem/release/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative '../../../lib/bake/gem/shell'
 

data/bake/gem.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative '../lib/bake/gem/helper'
 require_relative '../lib/bake/gem/shell'
@@ -44,6 +44,7 @@ end
 
 def release(tag: true)
 	@helper.guard_clean
+	@helper.guard_default_branch
 	
 	version = @helper.gemspec.version
 	

data/lib/bake/gem/helper.rb

@@ -19,6 +19,7 @@ module Bake
 				@gemspec = gemspec || find_gemspec
 			end
 			
+			attr :root
 			attr :gemspec
 			
 			def version_path
@@ -27,8 +28,8 @@ module Bake
 			
 			VERSION_PATTERN = /VERSION = ['"](?<value>\d+\.\d+\.\d+)(?<pre>.*?)['"]/
 			
-			def update_version(bump)
-				return unless version_path = self.version_path
+			def update_version(bump, version_path = self.version_path)
+				return false unless version_path
 				
 				lines = File.readlines(version_path)
 				version = nil
@@ -49,7 +50,9 @@ module Bake
 				end
 				
 				if version
-					yield version if block_given?
+					if block_given?
+						yield version
+					end
 					
 					File.write(version_path, lines.join)
 					
@@ -58,11 +61,24 @@ module Bake
 			end
 			
 			def guard_clean
-				lines = readlines("git", "status", "--porcelain")
+				lines = readlines("git", "status", "--porcelain", chdir: @root)
 				
 				if lines.any?
 					raise "Repository has uncommited changes!\n#{lines.join('')}"
 				end
+				
+				return true
+			end
+			
+			def guard_default_branch
+				branch = readlines("git", "branch", "--show-current", chdir: @root).first.chomp
+				remote_head_branch = readlines("git", "symbolic-ref", "refs/remotes/origin/HEAD", chdir: @root).first.chomp.split('/').last
+				
+				if branch != remote_head_branch
+					raise "Current branch is not the default branch: #{branch} != #{remote_head_branch}"
+				end
+				
+				return true
 			end
 			
 			# @parameter root [String] The root path for package files.
@@ -81,7 +97,7 @@ module Bake
 				elsif signing_key == true and @gemspec.signing_key.nil?
 					raise ArgumentError, "Signing key is required for signing the gem, but none was specified by the gemspec."
 				end
-
+				
 				::Gem::Package.build(@gemspec, false, false, output_path)
 			end
 			
@@ -93,8 +109,6 @@ module Bake
 				system("gem", "push", path, *arguments)
 			end
 			
-			private
-			
 			def find_gemspec(glob = "*.gemspec")
 				paths = Dir.glob(glob, base: @root).sort
 				

data/lib/bake/gem/shell.rb

@@ -1,35 +1,40 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
+
+require 'console'
+require 'console/event/spawn'
 
 module Bake
 	module Gem
 		module Shell
 			def system(*arguments, **options)
-				Console.logger.info(self, Console::Event::Spawn.for(*arguments, **options))
+				Console::Event::Spawn.for(*arguments, **options).emit(self)
 				
 				begin
 					pid = Process.spawn(*arguments, **options)
-					yield if block_given?
+					return yield if block_given?
 				ensure
 					pid, status = Process.wait2(pid) if pid
 					
 					unless status.success?
 						raise "Failed to execute #{arguments}: #{status}!"
 					end
+					
+					return true
 				end
 			end
 			
 			def execute(*arguments, **options)
-				Console.logger.info(self, Console::Event::Spawn.for(*arguments, **options))
+				Console::Event::Spawn.for(*arguments, **options).emit(self)
 				
 				IO.pipe do |input, output|
 					pid = Process.spawn(*arguments, out: output, **options)
 					output.close
 					
 					begin
-						yield input
+						return yield(input)
 					ensure
 						pid, status = Process.wait2(pid)
 						

data/lib/bake/gem/version.rb

@@ -5,6 +5,6 @@
 
 module Bake
 	module Gem
-		VERSION = "0.4.0"
+		VERSION = "0.6.0"
 	end
 end

data/lib/bake/gem.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2021-2022, by Samuel Williams.
+# Copyright, 2021-2024, by Samuel Williams.
 
 require_relative "gem/version"

data/license.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright, 2021-2023, by Samuel Williams.  
+Copyright, 2021-2024, by Samuel Williams.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -2,50 +2,31 @@
 
 Provides bake tasks for common gem release workflows.
 
-[![Test](https://github.com/ioquatix/bake-gem/workflows/Test/badge.svg)](https://github.com/ioquatix/bake-gem/actions?workflow=Test)
-
-## Installation
-
-``` shell
-$ bundle add bake-gem
-```
+[![Development Status](https://github.com/ioquatix/bake-gem/workflows/Test/badge.svg)](https://github.com/ioquatix/bake-gem/actions?workflow=Test)
 
 ## Usage
 
-### Local
-
-Releasing a gem locally is the most typical process.
-
-``` shell
-$ bake gem:release:version:(major|minor|patch) gem:release
-```
+Please see the [project documentation](https://ioquatix.github.io/bake-gem/) for more details.
 
-This will bump the gem version, commit it, build and push the gem, then tag it.
+  - [Getting Started](https://ioquatix.github.io/bake-gem/guides/getting-started/index) - This guide explains how to use `bake-gem` to release gems.
 
-### Automated
-
-Releasing a gem via a automated pipeline is also supported. Locally, create a release branch:
+## Contributing
 
-``` shell
-$ bake gem:release:branch:(major|minor|patch)
-```
+We welcome contributions to this project.
 
-This will create a branch, bump the gem version and commit it. You are then responsible for merging this into master (e.g. using a pull request). Once this is done, to automatically release the gem:
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
 
-``` shell
-$ export RUBYGEMS_HOST=...
-$ export GEM_HOST_API_KEY=...
+### Developer Certificate of Origin
 
-$ bake gem:release
-```
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
 
-## Contributing
+### Contributor Covenant
 
-1.  Fork it
-2.  Create your feature branch (`git checkout -b my-new-feature`)
-3.  Commit your changes (`git commit -am 'Add some feature'`)
-4.  Push to the branch (`git push origin my-new-feature`)
-5.  Create new Pull Request
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
 
 ## See Also
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bake-gem
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -37,50 +37,22 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2023-05-01 00:00:00.000000000 Z
+date: 2024-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: console
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '1.25'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: covered
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.25'
 description:
 email:
 executables: []
@@ -100,7 +72,9 @@ homepage: https://github.com/ioquatix/bake-gem
 licenses:
 - MIT
 metadata:
+  documentation_uri: https://ioquatix.github.io/bake-gem/
   funding_uri: https://github.com/sponsors/ioquatix/
+  source_code_uri: https://github.com/ioquatix/bake-gem.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -109,14 +83,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Release management for Ruby gems.