gemsmith 18.0.0 → 18.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7078991f9fcbcb707c47a3bbc7fb390725c3048c26de414728624f01a5a42a9e
-  data.tar.gz: aefb802ad6d7e39a454c553b40921c596c5000adee42e14f5e195eafcda95e0b
+  metadata.gz: 28fb66ba1ffc978d88dad82d5b14e898581da78cb8c599c9ba702b6a68c6ad21
+  data.tar.gz: 8cb98c3f67fcbc64cac58706430431b14429a7a5ad0399f14d03db04eb3f9215
 SHA512:
-  metadata.gz: 66f5dbee7fd91d463f89b8e95819eac28af1ee9af66bc1314d32103cd085a238c6dd8c8e7011e02ef588781f9397e3db3aacfb35b03a545f3e1fc67ea2591a6a
-  data.tar.gz: fd91bff49d27af059de47ace1aafacc50b0a4e7938e1b8627f5cb6b856498a64fab0bb4bcf4cbec47a339bf54f09d52e1d18788bc47bdaf849f615c5f83a6f0c
+  metadata.gz: afe90b17b858eae6e574b1f41af7b5ed9f7b95b421ff52a4726ce2a837116a3ceb759ab610e2a5eef06a088070773c96ce7467449e18ac3f6354a86efef18fbb
+  data.tar.gz: 47302fcdba57685e3c5b1f46cc082974194eb81217e350960aed20fd696c75a0741dc795cea271b1266955035b86e8c719ea5d1ef56fcbbf1842e9fb71654b63

data/README.adoc

@@ -39,7 +39,7 @@ gem install gemsmith
 If upgrading from 17.0.0 to 18.0.0, you'll want to be aware of the following changes:
 
 * The `--dead_end` build option has been removed.
-* The Milestoner configuraition has been updated to support ASCII Doc format by default and the
+* The Milestoner configuration has been updated to support ASCII Doc format by default and the
   ability to sign tags has been removed (this happens dynamically based on your Git configuration
   which gives you more flexibility).
 
@@ -71,6 +71,7 @@ BUILD OPTIONS:
       --[no-]console                       Add console script. Default: true.
       --[no-]contributions                 Add contributions documentation. Default: true.
       --[no-]debug                         Add Debug gem. Default: true.
+      --[no-]funding                       Add GitHub funding configuration. Default: false.
       --[no-]git                           Add Git. Default: true.
       --[no-]git_hub                       Add GitHub templates. Default: false.
       --[no-]git-lint                      Add Git Lint gem. Default: true.
@@ -290,8 +291,19 @@ gem cert --build you@example.com
 chmod 600 gem-*.pem
 ----
 
-The resulting `.pem` key files can be referenced via the `:private_key:` and `:public_key:` keys
-within the `$HOME/.gemsmithrc` file.
+The resulting `.pem` key files can be referenced via the `signing_key` and `cert_chain` of your
+`.gemspec` which Gemsmith provides for you via the `--security` build option. Example:
+
+[source,ruby]
+----
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  # Truncated for brevity.
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+end
+----
 
 To learn more about gem certificates, read about RubyGems
 link:https://guides.rubygems.org/security[Security].
@@ -321,7 +333,7 @@ Gem::Specification.new do |spec|
 end
 ----
 
-💡 The gemspec metadata _must_ be strings per the
+💡 The gemspec metadata (i.e. keys and values) _must_ be strings per the
 link:https://guides.rubygems.org/specification-reference/#metadata[RubyGems Specification].
 
 Use of the `allowed_push_host` key provides two important capabilities:
@@ -349,19 +361,19 @@ https://private.example.com: Basic dXNlcjpwYXNzd29yZA==
 
 Notice how the first line contains credentials for the public RubyGems server while the second line
 is for our private example server. You'll also notice that the key is not a symbol but a URL string
-to our private server. This is important as this is how we link our gem specification metadata to
-our private credentials. To illustrate further, here are both files truncated and shown together:
+to our private server. This is important because this is how we link our gem specification metadata
+to our private credentials. To illustrate further, here are both files truncated and shown together:
 
 ....
-# Gem specificaiton metadata which defines the private host to publish to.
+# Gem specification metadata which defines the private host to publish to.
 spec.metadata = {"allowed_push_host" => "https://private.example.com"}
 
 # Gem credentials where the URL value above becomes the key which enables authentication.
 https://private.example.com: Basic dXNlcjpwYXNzd29yZA==
 ....
 
-When the above are linked together like this, you enable Gemsmith to publish your gem using only the
-following command:
+When the above are linked together, you enable Gemsmith to publish your gem using only the following
+command:
 
 [source,bash]
 ----
@@ -369,8 +381,9 @@ gemsmith --publish
 ----
 
 This is especially powerful when publishing to
-link:https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry[GitHub's
-Packages registory] which would look like this when properly configured (truncated for brevity):
+link:https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry[GitHub
+Packages] which would look like this when properly configured (truncated for brevity while using
+fake data):
 
 ....
 # Gem specification
@@ -384,6 +397,62 @@ Lastly, should you need to delete a credential (due to a bad login/password for
 open the `$HOME/.gem/credentials` in your default editor and remove the line(s) you don't need. Upon
 next publish of your gem, you'll be prompted for the missing credentials.
 
+=== GitHub Actions/Packages Automation
+
+Earlier, I hinted at using GitHub Packages but what if you could automate the entire publishing
+process? Well, good news, you can by using GitHub Actions to publish your packages. Here's the YAML
+necessary to accomplish this endeavor:
+
+``` yaml
+name: Gemsmith
+
+on:
+  push:
+    branches: main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container:
+      image: ruby:latest
+    permissions:
+      contents: write
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: '0'
+          ref: ${{github.head_ref}}
+      - name: Setup
+        run: |
+          git config user.email "engineering@example.com"
+          git config user.name "Gemsmith Publisher"
+          mkdir -p $HOME/.gem
+          printf "%s\n" "https://rubygems.pkg.github.com/example: Bearer ${{secrets.GITHUB_TOKEN}}" > $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+      - name: Install
+        run: gem install gemsmith
+      - name: Publish
+        run: |
+          if git describe --tags --abbrev=0 > /dev/null 2>&1; then
+            gemsmith --publish
+          else
+            printf "%s\n" "First gem version must be manually created. Skipping."
+          fi
+```
+
+The above will ensure the following:
+
+* Only the first version requires manual publishing (hence the check for existing Git tags).
+* Duplicate versions are always skipped.
+* Only when a new version is detected (by changing your gemspec version) and you are on the `main`
+  branch will a new version be automatically published.
+
+This entire workflow is explained in my
+link:https://www.alchemists.io/talks/ruby_git_hub_packages[talk] on this exact subject too.
+
 == Promotion
 
 Once your gem is released, let the world know about your accomplishment by posting an update to
@@ -391,7 +460,6 @@ these sites:
 
 * link:https://rubyflow.com[RubyFlow]
 * link:https://ruby.libhunt.com[Ruby Library Hunt]
-* link:https://rubydaily.org[RubyDaily]
 * link:https://awesome-ruby.com[Awesome Ruby]
 * link:https://www.ruby-toolbox.com[Ruby Toolbox]
 * link:https://www.ruby-lang.org/en/community[Ruby Community]

data/gemsmith.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "gemsmith"
-  spec.version = "18.0.0"
+  spec.version = "18.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://www.alchemists.io/projects/gemsmith"
@@ -13,6 +13,7 @@ Gem::Specification.new do |spec|
     "bug_tracker_uri" => "https://github.com/bkuhlmann/gemsmith/issues",
     "changelog_uri" => "https://www.alchemists.io/projects/gemsmith/versions",
     "documentation_uri" => "https://www.alchemists.io/projects/gemsmith",
+    "funding_uri" => "https://github.com/sponsors/bkuhlmann",
     "label" => "Gemsmith",
     "rubygems_mfa_required" => "true",
     "source_code_uri" => "https://github.com/bkuhlmann/gemsmith"
@@ -28,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "dry-monads", "~> 1.4"
   spec.add_dependency "milestoner", "~> 14.0"
   spec.add_dependency "refinements", "~> 9.2"
-  spec.add_dependency "rubysmith", "~> 3.0"
+  spec.add_dependency "rubysmith", "~> 3.1"
   spec.add_dependency "runcom", "~> 8.2"
   spec.add_dependency "spek", "~> 0.2"
   spec.add_dependency "versionaire", "~> 10.0"

data/lib/gemsmith/templates/%project_name%/%project_name%.gemspec.erb

@@ -11,6 +11,7 @@ Gem::Specification.new do |spec|
     "bug_tracker_uri" => "<%= configuration.computed_project_url_issues %>",
     "changelog_uri" => "<%= configuration.computed_project_url_versions %>",
     "documentation_uri" => "<%= configuration.computed_project_url_home %>",
+    "funding_uri" => "<%= configuration.computed_project_url_funding %>",
     "label" => "<%= configuration.project_label %>",
     "rubygems_mfa_required" => "true",
     "source_code_uri" => "<%= configuration.computed_project_url_source %>"
@@ -28,9 +29,6 @@ Gem::Specification.new do |spec|
   <% if configuration.build_cli %>
     spec.add_dependency "dry-container", "~> 0.9"
   <% end %>
-  <% if configuration.build_cli %>
-    spec.add_dependency "pastel", "~> 0.8"
-  <% end %>
   <% if configuration.build_refinements %>
     spec.add_dependency "refinements", "~> 9.2"
   <% end %>

data/lib/gemsmith/tools/pusher.rb

@@ -34,7 +34,7 @@ module Gemsmith
         executor.capture3(check_yubikey.success, "oath", "accounts", "code", "--single", "RubyGems")
                 .then { |stdout, _stderr, status| status.success? ? ["--otp", stdout.chomp] : [] }
       rescue Errno::ENOENT => error
-        logger.warn { "Unable to obtain YubiKey One-Time Password. #{error}." }
+        logger.debug { "Unable to obtain YubiKey One-Time Password. #{error}." }
         []
       end
 
@@ -44,7 +44,7 @@ module Gemsmith
                   if status.success?
                     Success stdout.chomp
                   else
-                    logger.warn { "Unable to find YubiKey Manager. #{stderr}." }
+                    logger.debug { "Unable to find YubiKey Manager. #{stderr}." }
                     Failure()
                   end
                 end

data.tar.gz.sig

@@ -1 +1,2 @@
-�L0oq��U��š�'���T[��rHy�$��i2amje�g?ȅ]X������a�X^��#ޟ_���إ�|�S*L0������(�xn[B���}p�k�qtP��7׫�,�{
+��\m��p�_��f��E`|����ДPS
+Iw�9��1�A��D��˝6�>t�<vc<���pU��@N���\�!����E�0�.��{�	KY��oܲg��>�&�+G�{�U�(F>yR��W�/3�wK|�53O�t$�g��K�7�c0�? @�d�xĿ�`ݮ=��j;�����5�p�Eb���J��gz������'b�m���r�ש� ?=f����vS�q��(y���h

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 18.0.0
+  version: 18.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
   RFE=
   -----END CERTIFICATE-----
-date: 2022-04-10 00:00:00.000000000 Z
+date: 2022-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: auto_injector
@@ -120,14 +120,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
@@ -261,6 +261,7 @@ metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/gemsmith/issues
   changelog_uri: https://www.alchemists.io/projects/gemsmith/versions
   documentation_uri: https://www.alchemists.io/projects/gemsmith
+  funding_uri: https://github.com/sponsors/bkuhlmann
   label: Gemsmith
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/gemsmith
@@ -279,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.11
+rubygems_version: 3.3.12
 signing_key:
 specification_version: 4
 summary: A command line interface for smithing Ruby gems.