jekyll-keepachangelog 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cfcdf6000c7585f0107ab41edf39c5a0a717c29555ada6b1ee93059e8c09d8c6
+  data.tar.gz: 30a74ff2b95e165dbf61146b20ef6921b85601fa918ec82297780147ab465fc8
+SHA512:
+  metadata.gz: f0f4065655f0cbcc657902409326d2d7d110a64d7147a8c383fc6882fcc40e58066d4feb2c26b2739d5ddc41965b2ec68103f48400120ee552a16f9e7596fe3a
+  data.tar.gz: 48fb025f62dadda1f1037a63b5a0e42cd1d345f0882cf1617009839b60c6a2c2685fb0d5aebb1deeb31435e7e01037070078e6f800aa1eeb898ed7ee3d12b5fd

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jason Chance
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,122 @@
+# jekyll-keepachangelog
+
+A Jekyll plugin that parses a [Keep a Changelog](https://keepachangelog.com)–formatted `CHANGELOG.md` and exposes it as structured data at `site.data.changelog` for use in Liquid templates.
+
+## Installation
+
+Add to your site's `Gemfile`:
+
+```ruby
+gem "jekyll-keepachangelog"
+```
+
+Then add to `_config.yml`:
+
+```yaml
+plugins:
+  - jekyll-keepachangelog
+```
+
+Run `bundle install`.
+
+## Configuration
+
+By default the plugin reads `CHANGELOG.md` from your Jekyll site root. To use a different file:
+
+```yaml
+changelog:
+  file: docs/CHANGELOG.md
+```
+
+## Data structure
+
+`site.data.changelog` is an array of hashes, one per version section, in the order they appear in the file:
+
+```ruby
+[
+  {
+    "version"    => "1.2.0",
+    "date"       => "2024-03-15",   # String or nil for Unreleased
+    "unreleased" => false,          # true only for [Unreleased]
+    "sections"   => {
+      "Added"  => ["Feature A", "Feature B"],
+      "Fixed"  => ["Bug fix C"]
+    }
+  },
+  {
+    "version"    => "Unreleased",
+    "date"       => nil,
+    "unreleased" => true,
+    "sections"   => {
+      "Added" => ["Something upcoming"]
+    }
+  }
+]
+```
+
+- `version` — the version string inside `[…]`, e.g. `"1.2.0"` or `"Unreleased"`
+- `date` — the ISO 8601 date string after the ` - ` separator, or `nil`
+- `unreleased` — `true` when the version label is `Unreleased` (case-insensitive)
+- `sections` — hash of section name → array of item strings; only sections present in the file are included; an empty section is represented as `[]`
+
+Only top-level list items (lines starting with `- ` or `* ` at column 0) are captured. Indented sub-bullets are ignored.
+
+## Liquid template example
+
+```liquid
+{% for version in site.data.changelog %}
+  <h2>
+    {{ version.version }}
+    {% if version.date %} — {{ version.date }}{% endif %}
+  </h2>
+
+  {% for section in version.sections %}
+    <h3>{{ section[0] }}</h3>
+    <ul>
+      {% for item in section[1] %}
+        <li>{{ item }}</li>
+      {% endfor %}
+    </ul>
+  {% endfor %}
+{% endfor %}
+```
+
+## CHANGELOG.md format
+
+The plugin expects [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format:
+
+```markdown
+# Changelog
+
+## [Unreleased]
+### Added
+- Something coming soon
+
+## [1.2.0] - 2024-03-15
+### Added
+- Feature A
+- Feature B
+### Fixed
+- Bug fix C
+
+## [1.1.0] - 2024-01-10
+### Changed
+- Changed X
+```
+
+## Development
+
+```bash
+bundle install
+bundle exec ruby -Ilib test/changelog_test.rb
+```
+
+The parser (`lib/jekyll-keepachangelog/parser.rb`) has no Jekyll dependency and can be tested in isolation. The generator (`lib/jekyll/changelog_generator.rb`) wires the parser into the Jekyll build.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## License
+
+MIT — see [LICENSE.txt](LICENSE.txt).

data/lib/jekyll/changelog_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "jekyll-changelog/parser"
+
+module Jekyll
+  class ChangelogGenerator < Jekyll::Generator
+    safe true
+    priority :low
+
+    def generate(site)
+      filename = site.config.dig("changelog", "file") || "CHANGELOG.md"
+      path = File.join(site.source, filename)
+
+      unless File.exist?(path)
+        Jekyll.logger.warn "jekyll-changelog:", "#{filename} not found — skipping."
+        return
+      end
+
+      parser  = Jekyll::Keepachangelog::Parser.new
+      content = File.read(path, encoding: "utf-8")
+      site.data["changelog"] = parser.parse(content)
+    end
+  end
+end

data/lib/jekyll-keepachangelog/parser.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Keepachangelog
+    class Parser
+      VERSION_HEADING = /^##\s+\[([^\]]+)\](?:\s+-\s+(\d{4}-\d{2}-\d{2}))?/
+      SECTION_HEADING = /^###\s+(.+)/
+      BULLET_ITEM    = /^[-*]\s+(.+)/
+
+      def parse(markdown_text)
+        return [] if markdown_text.nil? || markdown_text.strip.empty?
+
+        entries = []
+        current_version = nil
+        current_section = nil
+
+        markdown_text.each_line do |raw_line|
+          line = raw_line.rstrip
+
+          if (m = VERSION_HEADING.match(line))
+            entries << build_entry(current_version) if current_version
+            label = m[1]
+            date  = m[2]
+            current_version = {
+              "version"    => label,
+              "date"       => date,
+              "unreleased" => label.casecmp("unreleased").zero?,
+              "_sections"  => {},
+              "_section"   => nil
+            }
+            current_section = nil
+
+          elsif (m = SECTION_HEADING.match(line)) && current_version
+            current_section = m[1].strip
+            current_version["_sections"][current_section] ||= []
+            current_version["_section"] = current_section
+
+          elsif (m = BULLET_ITEM.match(line)) && current_version && current_section
+            # Only capture top-level bullets (no leading spaces)
+            if raw_line =~ /\A[-*]\s/
+              current_version["_sections"][current_section] << m[1].strip
+            end
+          end
+        end
+
+        entries << build_entry(current_version) if current_version
+        entries
+      end
+
+      private
+
+      def build_entry(data)
+        {
+          "version"    => data["version"],
+          "date"       => data["date"],
+          "unreleased" => data["unreleased"],
+          "sections"   => data["_sections"]
+        }
+      end
+    end
+  end
+end

data/lib/jekyll-keepachangelog/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Keepachangelog
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll-keepachangelog.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "jekyll-keepachangelog/version"
+require "jekyll-changelog/parser"
+require "jekyll/changelog_generator"

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-keepachangelog
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Chance
+bindir: bin
+cert_chain: []
+date: 2026-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Parses a Keep a Changelog–formatted CHANGELOG.md and exposes it as site.data.changelog
+  — an array of version hashes — for use in Liquid templates.
+email:
+- jason@jasonchance.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll-keepachangelog.rb
+- lib/jekyll-keepachangelog/parser.rb
+- lib/jekyll-keepachangelog/version.rb
+- lib/jekyll/changelog_generator.rb
+homepage: https://github.com/jchance/jekyll-keepachangelog
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jchance/jekyll-keepachangelog
+  source_code_uri: https://github.com/jchance/jekyll-keepachangelog
+  changelog_uri: https://github.com/jchance/jekyll-keepachangelog/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Render your CHANGELOG.md as structured data in Jekyll.
+test_files: []