astro/packages/astro-rss/CHANGELOG.md

@astrojs/rss

4.0.1

Patch Changes

• #9299 edfae50e6 Thanks @cdvillard! - Improves the @astrojs/rss error message thrown when the object passed to the items property is missing any of the three required keys or if one of those keys is mistyped.

4.0.0

Major Changes

• #9168 153a5abb9 Thanks @bluwy! - Removes the deprecated (in v3.0) drafts option as the feature is deprecated in Astro 3.0

4.0.0-beta.0

Major Changes

• #9168 153a5abb9 Thanks @bluwy! - Removes the drafts option as the feature is deprecated in Astro 3.0

3.0.0

Major Changes

• #8188 d0679a666 Thanks @ematipico! - Remove support for Node 16. The lowest supported version by Astro and all integrations is now v18.14.1. As a reminder, Node 16 will be deprecated on the 11th September 2023.

• #8179 6011d52d3 Thanks @matthewp! - Astro 3.0 Release Candidate

• #8198 cb95aa5f8 Thanks @bluwy! - Update the rss() default export to return a Response instead of a simple object, which is deprecated in Astro 3.0. If you were directly returning the rss() result from an endpoint before, this breaking change should not affect you.

  You can also import getRssString() to get the RSS string directly and use it to return your own Response:

  // src/pages/rss.xml.js
  import { getRssString } from '@astrojs/rss';
  
  export async function get(context) {
    const rssString = await getRssString({
      title: 'Buzz’s Blog',
      ...
    });
  
    return new Response(rssString, {
      headers: {
        'Content-Type': 'application/xml',
      },
    });
  }
  

Patch Changes

• #8099 732111cdc Thanks @bluwy! - Deprecate the markdown.drafts configuration option.

  If you'd like to create draft pages that are visible in dev but not in production, you can migrate to content collections and manually filter out pages with the draft: true frontmatter property instead.

3.0.0-rc.2

Major Changes

• #8198 cb95aa5f8 Thanks @bluwy! - Update the rss() default export to return a Response instead of a simple object, which is deprecated in Astro 3.0. If you were directly returning the rss() result from an endpoint before, this breaking change should not affect you.

  You can also import getRssString() to get the RSS string directly and use it to return your own Response:

  // src/pages/rss.xml.js
  import { getRssString } from '@astrojs/rss';
  
  export async function get(context) {
    const rssString = await getRssString({
      title: 'Buzz’s Blog',
      ...
    });
  
    return new Response(rssString, {
      headers: {
        'Content-Type': 'application/xml',
      },
    });
  }
  

3.0.0-rc.1

Major Changes

• #8179 6011d52d3 Thanks @matthewp! - Astro 3.0 Release Candidate

Patch Changes

• #8099 732111cdc Thanks @bluwy! - Deprecate the markdown.drafts configuration option.

  If you'd like to create draft pages that are visible in dev but not in production, you can migrate to content collections and manually filter out pages with the draft: true frontmatter property instead.

3.0.0-beta.0

Major Changes

• 1eae2e3f7 Thanks @Princesseuh! - Remove support for Node 16. The lowest supported version by Astro and all integrations is now v18.14.1. As a reminder, Node 16 will be deprecated on the 11th September 2023.

2.4.4

Patch Changes

• #7964 51028f85c Thanks @DerTimonius! - Add URL to RSSOptions.site type

2.4.3

Patch Changes

• #7153 e17ed0727 Thanks @AkashRajpurohit! - exposes RSSFeedItem type

2.4.2

Patch Changes

• #7066 a37e67b52 Thanks @TheOtterlord! - Fix pubDate schema tranformation

• #7104 826e02890 Thanks @bluwy! - Specify "files" field to only publish necessary files

2.4.1

Patch Changes

• #6970 b5482cee2 Thanks @bholmesdev! - Fix: remove accidental stripping of trailing /1/ on canonical URLs

2.4.0

Minor Changes

• #6707 4ea716e56 Thanks @philnash! - Added extra elements to the RSS items, including categories and enclosure

2.3.2

Patch Changes

• #6614 b1b9b1390 Thanks @aivarsliepa! - Fixes RSSOptions type error when using strictest Typescript tsconfig

2.3.1

Patch Changes

• #6538 400ef26c9 Thanks @bholmesdev! - Preserve self-closing tags in customData option

2.3.0

Minor Changes

• #6453 2e362042c Thanks @ematipico! - Added trailingSlash option to control whether or not the emitted URLs should have trailing slashes.

  import rss from '@astrojs/rss';
  
  export const get = () =>
    rss({
      trailingSlash: false,
    });
  

  By passing false, the emitted links won't have trailing slashes.

2.2.0

Minor Changes

• #6213 afbbc4d5b Thanks @Princesseuh! - Updated compilation settings to disable downlevelling for Node 14

2.1.1

Patch Changes

• #6259 dbffee4e3 Thanks @y-nk! - Improve RSS schema errors with additional property name context

2.1.0

Minor Changes

• #5851 81dce94f2 Thanks @bholmesdev! - Update RSS config for readability and consistency with Astro 2.0.

  • Migration - import.meta.glob() handling

    We have deprecated items: import.meta.glob(...) handling in favor of a separate pagesGlobToRssItems() helper. This simplifies our items configuration option to accept a single type, without losing existing functionality.

    If you rely on our import.meta.glob() handling, we suggest adding the pagesGlobToRssItems() wrapper to your RSS config:

    // src/pages/rss.xml.js
    import rss, {
    +  pagesGlobToRssItems
    } from '@astrojs/rss';
    
    export function get(context) {
      return rss({
    +    items: pagesGlobToRssItems(
          import.meta.glob('./blog/*.{md,mdx}'),
    +    ),
      });
    }
    

  • New rssSchema for content collections

    @astrojs/rss now exposes an rssSchema for use with content collections. This ensures all RSS feed properties are present in your frontmatter:

    import { defineCollection } from 'astro:content';
    import { rssSchema } from '@astrojs/rss';
    
    const blog = defineCollection({
      schema: rssSchema,
    });
    
    export const collections = { blog };
    

2.1.0-beta.0

See changes in 2.1.0-beta.0

Minor Changes

• #5851 81dce94f2 Thanks @bholmesdev! - Update RSS config for readability and consistency with Astro 2.0.

  • Migration - import.meta.glob() handling

    We have deprecated items: import.meta.glob(...) handling in favor of a separate pagesGlobToRssItems() helper. This simplifies our items configuration option to accept a single type, without losing existing functionality.

    If you rely on our import.meta.glob() handling, we suggest adding the pagesGlobToRssItems() wrapper to your RSS config:

    // src/pages/rss.xml.js
    import rss, {
    +  pagesGlobToRssItems
    } from '@astrojs/rss';
    
    export function get(context) {
      return rss({
    +    items: pagesGlobToRssItems(
          import.meta.glob('./blog/*.{md,mdx}'),
    +    ),
      });
    }
    

  • New rssSchema for content collections

    @astrojs/rss now exposes an rssSchema for use with content collections. This ensures all RSS feed properties are present in your frontmatter:

    import { defineCollection } from 'astro:content';
    import { rssSchema } from '@astrojs/rss';
    
    const blog = defineCollection({
      schema: rssSchema,
    });
    
    export const collections = { blog };
    

2.0.0

Major Changes

• #5612 68c20be66 Thanks @equt! - Filter out draft in RSS generation

1.2.1

Patch Changes

• #5600 c4155daea Thanks @fflaten! - Fix missing type-attribute in xml-stylesheet

1.2.0

Minor Changes

• c76e1c810 Thanks @mattstein! - Fixes a bug that prevented an item’s customData from being included.

1.1.0

Minor Changes

• #5366 081e0a9d2 Thanks @smithbm2316! - Added the ability for users to include the full content of their posts/items in each RSS feed entry via the new content key on the RSSFeedItem model.

Patch Changes

• #5550 fe0da0185 Thanks @andersk! - Generate RSS feed with proper XML escaping

1.0.3

Patch Changes

• #5164 4a8a346ca Thanks @MoustaphaDev! - Add support for markdown files with the following extensions:
  • .markdown
  • .mdown
  • .mkdn
  • .mkd
  • .mdwn

1.0.2

Patch Changes

• #4842 812658ad2 Thanks @bluwy! - Add missing dependencies, support strict dependency installation (e.g. pnpm)

• #4842 812658ad2 Thanks @bluwy! - Remove path-browserify dependency

1.0.1

Patch Changes

• #4701 6e1d62fe2 Thanks @bholmesdev! - Fix globs for homepage route

1.0.0

Major Changes

• 04ad44563 - > Astro v1.0 is out! Read the official announcement post.

  No breaking changes. This package is now officially stable and compatible with astro@1.0.0!

0.2.2

Patch Changes

• #3956 57e529e4c Thanks @esafev! - Throw the error when 'site' option is missing

0.2.1

Patch Changes

• #3913 cd2dbfedb Thanks @matthewp! - Adds error messages for missing required fields

0.2.0

Minor Changes

• #3301 0efaf110 Thanks @bholmesdev! - Change the optional "canonicalUrl" argument to a required "site" argument. This fixes problems with import.meta.env.SITE. If you want to use your project's "site" field for your RSS feeds, set site: import.meta.env.SITE in the rss function options

0.1.1

Patch Changes

• 1032e450 Thanks @FredKSchott! - Introduce new @astrojs/rss package for RSS feed generation! This also adds a new global env variable for your project's configured "site": import.meta.env.SITE. This is consumed by the RSS feed helper to generate the correct canonical URL.