jekyll-feed 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 218e5f581b3f29f0f04eb49800c27b61cecb2ec769882ef2aa00008db2d6bd1a
-  data.tar.gz: b3f1ed32d77b488d45c5fcea9540224d2d340660b37db61958b4cd24d37e3bcc
+  metadata.gz: da9056c2c44badd5c199ed742ea665ad315fa7c6a1924a5ee659a9167a069ea9
+  data.tar.gz: addb0b079cc0de3c0217bd9ce525ce9272f84d02a463ae15d7a3076ee13bc82b
 SHA512:
-  metadata.gz: 2b6f1f23ae300ac0caad7a2123e73fb0ea403a9481a1bf71c90b07a166e91c4f64576d48606c960452e431fc1d26cb1531a6649dd622ad0d9c80722edc2a8d3c
-  data.tar.gz: de139bea2ba933414be45fcc6a4fe9e8e7431e8b7ea0bccc2df365121748e4bf07cd9020968670889c84688cc080ce22dc576b1d3936b8c34c07f7eabac727c5
+  metadata.gz: 44ccc5f9288c5d4f394ed8674444fbefd504ba5eb9e64c821cdcc501aa1b12c2f4f2195ae1d60820954d826f81e2485676e0c855fbde206854170134decbf95d
+  data.tar.gz: 26d328fc69fb541a438b81177d2739a168483731dea9923446a0226e82ff5df8f7fe331647c27541a5285613341b9f006d1f92daf2d0e370cc2cb8cf63fdc125

data/History.markdown

@@ -1,3 +1,23 @@
+## 0.18.0 / 2026-09-29
+
+### Security
+
+  * Escape `xml:lang` values and CDATA terminators in the feed (GHSA-3gx8-pqcm-38hw, #396)
+
+### Development Fixes
+
+  * Upgrade to Rake 13 to fix master (#381)
+  * feat(CI): Add Ruby 3.2/3.3 to the test matrix (#402)
+  * Fix style offenses (#414)
+
+### Documentation
+
+  * Fix typos in Readme (#384)
+
+### Minor Enhancements
+
+  * Icon and logo support with simple tests (#412)
+
 ## 0.17.0 / 2022-10-14
 
 ### Documentation
@@ -139,8 +159,6 @@
 
   * fix <entry> template for posts with post.lang defined (#168)
 
-## 0.9.3 / 2017-03-28
-
 ## 0.9.1 / 2017-02-17
 
 ### Minor Enhancements

data/README.md

@@ -33,6 +33,15 @@ The plugin will automatically use any of the following configuration variables,
 * `description` - A longer description of what your site is about, e.g., "Where I blog about Jekyll and other awesome things"
 * `url` - The URL to your site, e.g., `https://example.com`. If none is provided, the plugin will try to use `site.github.url`.
 * `author` - Global author information (see below)
+* `feed.icon` - Icon with 1:1 proportions for readers to use for the blog feed (not supported by all readers; often overridden by a favicon or site icon)
+* `feed.logo` - Logo with 2:1 proportions for readers to use for the blog feed (not supported by all readers). 
+  For example, both of the preceding can be expressed:
+  ```yml
+  feed:
+    icon: /images/icon.png
+    logo: /images/logo.png
+  ```
+
 
 ### Already have a feed path?
 
@@ -70,7 +79,7 @@ Additionally, the plugin will use the following values, if present in a post's Y
 
 There are several ways to convey author-specific information. Author information is found in the following order of priority:
 
-1. An `author` object, in the documents's front matter, e.g.:
+1. An `author` object, in the document's front matter, e.g.:
 
   ```yml
   author:
@@ -181,7 +190,7 @@ feed:
       path: "/changes.atom"
 ```
 
-Finally, collections can also have category feeds which are outputted as `/feed/<COLLECTION>/<CATEGORY>.xml`. Specify categories like so:
+Finally, collections can also have category feeds that are outputted as `/feed/<COLLECTION>/<CATEGORY>.xml`. Specify categories like so:
 
 ```yml
 feed:
@@ -197,15 +206,15 @@ feed:
 
 Optional flag `excerpt_only` allows you to exclude post content from the Atom feed. Default value is `false` for backward compatibility.
 
-When in `config.yml` is `true` than all posts in feed will be without `<content>` tags.
+When in `config.yml` is `true` then all posts in feed will be without `<content>` tags.
 
 ```yml
 feed:
   excerpt_only: true
 ```
 
-The same flag can be used directly in post file. It will be disable `<content>` tag for selected post.
-Settings in post file has higher priority than in config file.
+The same flag can be used directly in post file. It will disable `<content>` tag for selected post.
+Settings in post file have higher priority than in config file.
 
 ## Tags
 

data/lib/jekyll-feed/feed.xml

@@ -2,10 +2,10 @@
 {% if page.xsl %}
   <?xml-stylesheet type="text/xml" href="{{ '/feed.xslt.xml' | absolute_url }}"?>
 {% endif %}
-<feed xmlns="http://www.w3.org/2005/Atom" {% if site.lang %}xml:lang="{{ site.lang }}"{% endif %}>
+<feed xmlns="http://www.w3.org/2005/Atom" {% if site.lang %}xml:lang="{{ site.lang | xml_escape }}"{% endif %}>
   <generator uri="https://jekyllrb.com/" version="{{ jekyll.version }}">Jekyll</generator>
   <link href="{{ page.url | absolute_url }}" rel="self" type="application/atom+xml" />
-  <link href="{{ '/' | absolute_url }}" rel="alternate" type="text/html" {% if site.lang %}hreflang="{{ site.lang }}" {% endif %}/>
+  <link href="{{ '/' | absolute_url }}" rel="alternate" type="text/html" {% if site.lang %}hreflang="{{ site.lang | xml_escape }}" {% endif %}/>
   <updated>{{ site.time | date_to_xmlschema }}</updated>
   <id>{{ page.url | absolute_url | xml_escape }}</id>
 
@@ -27,6 +27,22 @@
     <subtitle>{{ site.description | xml_escape }}</subtitle>
   {% endif %}
 
+  {% if site.feed.icon %}
+    {% assign feed_icon = site.feed.icon %}
+    {% unless feed_icon contains "://" %}
+      {% assign feed_icon = feed_icon | absolute_url %}
+    {% endunless %}
+    <icon>{{ feed_icon | xml_escape }}</icon>
+  {% endif %}
+
+  {% if site.feed.logo %}
+    {% assign feed_logo = site.feed.logo %}
+    {% unless feed_logo contains "://" %}
+      {% assign feed_logo = feed_logo | absolute_url %}
+    {% endunless %}
+    <logo>{{ feed_logo | xml_escape }}</logo>
+  {% endif %}
+
   {% if site.author %}
     <author>
         <name>{{ site.author.name | default: site.author | xml_escape }}</name>
@@ -52,8 +68,10 @@
   {% endunless %}
   {% assign posts = posts | sort: "date" | reverse %}
   {% assign posts_limit = site.feed.posts_limit | default: 10 %}
+  {% assign cdata_end_token = "]]>" %}
+  {% assign cdata_end_token_escaped = "]]]]><![CDATA[>" %}
   {% for post in posts limit: posts_limit %}
-    <entry{% if post.lang %}{{" "}}xml:lang="{{ post.lang }}"{% endif %}>
+    <entry{% if post.lang %}{{" "}}xml:lang="{{ post.lang | xml_escape }}"{% endif %}>
       {% assign post_title = post.title | smartify | strip_html | normalize_whitespace | xml_escape %}
 
       <title type="html">{{ post_title }}</title>
@@ -63,7 +81,7 @@
       <id>{{ post.id | absolute_url | xml_escape }}</id>
       {% assign excerpt_only = post.feed.excerpt_only | default: site.feed.excerpt_only %}
       {% unless excerpt_only %}
-        <content type="html" xml:base="{{ post.url | absolute_url | xml_escape }}"><![CDATA[{{ post.content | strip }}]]></content>
+        <content type="html" xml:base="{{ post.url | absolute_url | xml_escape }}"><![CDATA[{{ post.content | strip | replace: cdata_end_token, cdata_end_token_escaped }}]]></content>
       {% endunless %}
 
       {% assign post_author = post.author | default: post.authors[0] | default: site.author %}
@@ -96,7 +114,7 @@
 
       {% assign post_summary = post.description | default: post.excerpt %}
       {% if post_summary and post_summary != empty %}
-        <summary type="html"><![CDATA[{{ post_summary | strip_html | normalize_whitespace }}]]></summary>
+        <summary type="html"><![CDATA[{{ post_summary | strip_html | normalize_whitespace | replace: cdata_end_token, cdata_end_token_escaped }}]]></summary>
       {% endif %}
 
       {% assign post_image = post.image.path | default: post.image %}

data/lib/jekyll-feed/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Feed
-    VERSION = "0.17.0"
+    VERSION = "0.18.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-feed
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-15 00:00:00.000000000 Z
+date: 2026-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -158,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A Jekyll plugin to generate an Atom feed of your Jekyll posts