mdtoc 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f53365d2172397bc4b50a26f88ce05d13c8766453b56c96fd1513151b2d72cad
-  data.tar.gz: c49f859803c2bf3928c51f70535ba35a9bffda3ccc69457713977497c6a50f6e
+  metadata.gz: 18181b859f98c2413c06fc51d9cb02d6350eda1e82953019dc7007e48a00784b
+  data.tar.gz: 6bcd6502f07056de61e2ac6679b296338babbfd5470b731a2a7ca6ccc0f06259
 SHA512:
-  metadata.gz: de596f6886429e537d249cc2c2516521cfb23ee8c407f002348a68fe93b3de30f0b6e4809d64c5c2e75858e33791e4507d9060c35c79a8f0459202c105e54b73
-  data.tar.gz: 8da62161d757e8be2c7970ed076b58ea1dbc0b1416e35d497dbc5545faf84764ab88e08895f21c3995e98acd2c1f0f88bec4c9b96b5bcb3f27ad6a80ef07b88e
+  metadata.gz: 8045d2d699f6f6fcdd5d2c5671ed08950c279f3a6c3d836f149f1bfc7d8edad60582cf2539f2e042ebabde2b99b3eb7ccf0b6c3476fb294ba170afbe9c787b6f
+  data.tar.gz: d077544177ade528172c9642df28174c596ba663e658ea36b838d8fc616eb662960be342fa030137a987eace0e2615389c339562d1cde09997038d9416f866f5

data/README.md

@@ -1,5 +1,8 @@
 # mdtoc - Markdown Table of Contents
 
+[![CI](https://github.com/andornaut/mdtoc/actions/workflows/release.yml/badge.svg)](https://github.com/andornaut/mdtoc/actions/workflows/release.yml)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 Read Markdown files and output a table of contents.
 
 ## Installation
@@ -40,10 +43,9 @@ Usage: mdtoc [options] files or directories...
 Create a `Rakefile` with the contents below, then run
 [`rake`](https://github.com/ruby/rake) to:
 
-* `git pull`
-* `git add` any `*.md` files
 * Run `mdtoc` to update the generated table of contents in the ./README.md file
-* Git commit and push any changes
+* `git add` any `*.md` files
+* Git commit, pull, and push any changes
 
 ```ruby
 task default: %w[mdtoc]
@@ -57,7 +59,7 @@ task :mdtoc do
       exit 1
     fi
     mdtoc --append --create --output README.md docs/
-    git add *.md **/*.md
+    git add README.md docs/*.md
     git commit -qm 'Update TOC' || true
     git pull
     git push
@@ -70,9 +72,9 @@ task :mdtoc do
 end
 ```
 
-See [andornaut/til](https://github.com/andornaut/til/blob/master/Rakefile) for an example.
+See [andornaut/til](https://github.com/andornaut/til/blob/main/Rakefile) for an example.
 
-## Development
+## Developing
 
 ### Setup
 
@@ -110,4 +112,14 @@ f=$(mktemp) && ruby -Ilib bin/mdtoc -aco ${f} test/samples ; cat ${f}
 1. Bump version in `lib/mdtoc/version.rb`
 2. Run `bundle install` to update `Gemfile.lock`
 3. Commit the changes
-4. Run `rake release` to publish the gem to RubyGems, create the git tag, and push
+4. Tag the commit `vX.Y.Z` and push the tag
+
+Pushing the tag is the whole release. The Release workflow runs the checks,
+builds the gem, cuts the GitHub release, and pushes that same gem to RubyGems.
+`rake release` is not run by hand.
+
+Nothing here holds a RubyGems API key. The workflow authenticates with a
+short-lived credential minted from its own OIDC claim, against a trusted
+publisher registered on RubyGems that names this repository and
+`.github/workflows/release.yml`. Renaming that file stops publishing until the
+trusted publisher is updated to match.

data/bin/mdtoc

@@ -2,5 +2,5 @@
 # typed: true
 # frozen_string_literal: true
 
-require "mdtoc"
+require 'mdtoc'
 Mdtoc.main(ARGV)

data/lib/mdtoc/node.rb

@@ -28,9 +28,7 @@ module Mdtoc
       def render(paths)
         headers = paths.flat_map { |path| for_path(path).headers }
         min_depth = headers.map(&:depth).min || 0
-        if min_depth.positive?
-          headers.each { |h| h.depth -= min_depth }
-        end
+        headers.each { |h| h.depth -= min_depth } if min_depth.positive?
         headers.join("\n")
       end
     end

data/lib/mdtoc/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module Mdtoc
-  VERSION = '0.4.0'
+  VERSION = '0.4.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdtoc
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - andornaut
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-03-25 00:00:00.000000000 Z
+date: 2026-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: unparser
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +111,9 @@ dependencies:
 description: |
   # mdtoc - Markdown Table of Contents
 
+  [![CI](https://github.com/andornaut/mdtoc/actions/workflows/release.yml/badge.svg)](https://github.com/andornaut/mdtoc/actions/workflows/release.yml)
+  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
   Read Markdown files and output a table of contents.
 
   ## Installation
@@ -151,10 +154,9 @@ description: |
   Create a `Rakefile` with the contents below, then run
   [`rake`](https://github.com/ruby/rake) to:
 
-  * `git pull`
-  * `git add` any `*.md` files
   * Run `mdtoc` to update the generated table of contents in the ./README.md file
-  * Git commit and push any changes
+  * `git add` any `*.md` files
+  * Git commit, pull, and push any changes
 
   ```ruby
   task default: %w[mdtoc]
@@ -168,7 +170,7 @@ description: |
         exit 1
       fi
       mdtoc --append --create --output README.md docs/
-      git add *.md **/*.md
+      git add README.md docs/*.md
       git commit -qm 'Update TOC' || true
       git pull
       git push
@@ -181,9 +183,9 @@ description: |
   end
   ```
 
-  See [andornaut/til](https://github.com/andornaut/til/blob/master/Rakefile) for an example.
+  See [andornaut/til](https://github.com/andornaut/til/blob/main/Rakefile) for an example.
 
-  ## Development
+  ## Developing
 
   ### Setup
 
@@ -221,7 +223,17 @@ description: |
   1. Bump version in `lib/mdtoc/version.rb`
   2. Run `bundle install` to update `Gemfile.lock`
   3. Commit the changes
-  4. Run `rake release` to publish the gem to RubyGems, create the git tag, and push
+  4. Tag the commit `vX.Y.Z` and push the tag
+
+  Pushing the tag is the whole release. The Release workflow runs the checks,
+  builds the gem, cuts the GitHub release, and pushes that same gem to RubyGems.
+  `rake release` is not run by hand.
+
+  Nothing here holds a RubyGems API key. The workflow authenticates with a
+  short-lived credential minted from its own OIDC claim, against a trusted
+  publisher registered on RubyGems that names this repository and
+  `.github/workflows/release.yml`. Renaming that file stops publishing until the
+  trusted publisher is updated to match.
 email:
 executables:
 - mdtoc
@@ -253,7 +265,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="