diff options
Diffstat (limited to 'packages/astro-rss')
| -rw-r--r-- | packages/astro-rss/CHANGELOG.md | 6 | ||||
| -rw-r--r-- | packages/astro-rss/README.md | 4 | ||||
| -rw-r--r-- | packages/astro-rss/package.json | 2 | ||||
| -rw-r--r-- | packages/astro-rss/src/index.ts | 10 | ||||
| -rw-r--r-- | packages/astro-rss/tsconfig.json | 2 |
5 files changed, 18 insertions, 6 deletions
diff --git a/packages/astro-rss/CHANGELOG.md b/packages/astro-rss/CHANGELOG.md index 1f06b449e..a3c99b642 100644 --- a/packages/astro-rss/CHANGELOG.md +++ b/packages/astro-rss/CHANGELOG.md @@ -1,5 +1,11 @@ # @astrojs/rss +## 3.0.0-beta.0 + +### Major Changes + +- [`1eae2e3f7`](https://github.com/withastro/astro/commit/1eae2e3f7d693c9dfe91c8ccfbe606d32bf2fb81) Thanks [@Princesseuh](https://github.com/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 diff --git a/packages/astro-rss/README.md b/packages/astro-rss/README.md index 47dfc1747..2a2fb7db2 100644 --- a/packages/astro-rss/README.md +++ b/packages/astro-rss/README.md @@ -65,8 +65,6 @@ export function get(context) { site: context.site, // list of `<item>`s in output xml items: [...], - // include draft posts in the feed (default: false) - drafts: true, // (optional) absolute path to XSL stylesheet in your project stylesheet: '/rss-styles.xsl', // (optional) inject custom xml @@ -118,6 +116,8 @@ When providing a formatted RSS item list, see the [`RSSFeedItem` type reference] Type: `boolean (optional)` +**Deprecated**: Manually filter `items` instead. + Set `drafts: true` to include [draft posts](https://docs.astro.build/en/guides/markdown-content/#draft-pages) in the feed output. By default, this option is `false` and draft posts are not included. ### stylesheet diff --git a/packages/astro-rss/package.json b/packages/astro-rss/package.json index f3b7c9c12..2491f6a66 100644 --- a/packages/astro-rss/package.json +++ b/packages/astro-rss/package.json @@ -1,7 +1,7 @@ { "name": "@astrojs/rss", "description": "Add RSS feeds to your Astro projects", - "version": "2.4.4", + "version": "3.0.0-beta.0", "type": "module", "types": "./dist/index.d.ts", "author": "withastro", diff --git a/packages/astro-rss/src/index.ts b/packages/astro-rss/src/index.ts index 4d97647f1..843edd146 100644 --- a/packages/astro-rss/src/index.ts +++ b/packages/astro-rss/src/index.ts @@ -27,7 +27,10 @@ export type RSSOptions = { stylesheet?: z.infer<typeof rssOptionsValidator>['stylesheet']; /** Specify custom data in opening of file */ customData?: z.infer<typeof rssOptionsValidator>['customData']; - /** Whether to include drafts or not */ + /** + * Whether to include drafts or not + * @deprecated Deprecated since version 3.0. Use content collections instead. + */ drafts?: z.infer<typeof rssOptionsValidator>['drafts']; trailingSlash?: z.infer<typeof rssOptionsValidator>['trailingSlash']; }; @@ -45,7 +48,10 @@ export type RSSFeedItem = { description?: z.infer<typeof rssSchema>['description']; /** Append some other XML-valid data to this item */ customData?: z.infer<typeof rssSchema>['customData']; - /** Whether draft or not */ + /** + * Whether draft or not + * @deprecated Deprecated since version 3.0. Use content collections instead. + */ draft?: z.infer<typeof rssSchema>['draft']; /** Categories or tags related to the item */ categories?: z.infer<typeof rssSchema>['categories']; diff --git a/packages/astro-rss/tsconfig.json b/packages/astro-rss/tsconfig.json index f9da2a5bd..d8efd2fec 100644 --- a/packages/astro-rss/tsconfig.json +++ b/packages/astro-rss/tsconfig.json @@ -5,7 +5,7 @@ "allowJs": true, "module": "ES2022", "outDir": "./dist", - "target": "ES2021", + "target": "ES2022", "strictNullChecks": true } } |