gemsmith 18.0.2 → 18.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: badab9b933b3cc8009dcce38b6c849c38e7b6d90fb849bda9ba3426e9d8c76fe
-  data.tar.gz: 48386d0058700e7ab46b0ce1189b8264f7c0dcf75f4e2d11b0a702c5bb82a858
+  metadata.gz: 28fb66ba1ffc978d88dad82d5b14e898581da78cb8c599c9ba702b6a68c6ad21
+  data.tar.gz: 8cb98c3f67fcbc64cac58706430431b14429a7a5ad0399f14d03db04eb3f9215
 SHA512:
-  metadata.gz: 3dcd01d2e1c468062c19c060e080140eb6fd5da9dbbc408bdd0a4bdaa2db6e45e7bfdf066d94719380410a3f96d268a38632ff67bd01f4bfe07cc7fa1899e063
-  data.tar.gz: e43ce7b51bb41176925c911f80d40e8c88d464ce84e7effdf03ef4f0d1a09dc40737bf605aefa3db816e8fed511a7a56cef94b82b06f9ee1c90845b58ae6b4a5
+  metadata.gz: afe90b17b858eae6e574b1f41af7b5ed9f7b95b421ff52a4726ce2a837116a3ceb759ab610e2a5eef06a088070773c96ce7467449e18ac3f6354a86efef18fbb
+  data.tar.gz: 47302fcdba57685e3c5b1f46cc082974194eb81217e350960aed20fd696c75a0741dc795cea271b1266955035b86e8c719ea5d1ef56fcbbf1842e9fb71654b63

data/README.adoc

@@ -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,8 @@ gem cert --build you@example.com
 chmod 600 gem-*.pem
 ----
 
-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:
+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]
 ----
@@ -332,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:
@@ -360,8 +361,8 @@ 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 specification metadata which defines the private host to publish to.
@@ -371,8 +372,8 @@ spec.metadata = {"allowed_push_host" => "https://private.example.com"}
 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]
 ----
@@ -380,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
@@ -395,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
@@ -402,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.2"
+  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 %>"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemsmith
 version: !ruby/object:Gem::Version
-  version: 18.0.2
+  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-22 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.