mirror of
https://github.com/withastro/astro.git
synced 2024-12-23 21:53:55 -05:00
81dce94f2a
* chore: strictNullChecks for zod * feat: expose `rssSchema` helper * refactor: align types with schema types * feat: break glob handler to globToRssItems util * refactor: RSS options validation to Zod * refactor: avoid intermediate type * fix: allow numbers and dates in pubDate * test: update glob and error tests * feat: add rss to with-content starter * fix: move globToRssItems back to internal behavior * chore: JSON.stringify * Revert "fix: move globToRssItems back to internal behavior" This reverts commit 85305075e6444907455541b24bccbccd5016951a. * test: missing url * docs: `import.meta.env.SITE` -> `context.site` * docs: update README to content collections example * fix: url -> link * docs: add `rssSchema` to README * chore: consistent formatting * docs: add `pagesGlobToRssItems()` reference * chore: globToRssItems -> pagesGlobToRssItems * chore: changeset * fix: bad docs line highlighting * fix: add collections export to example * nit: remove "our" * fix: are -> all * fix: more README edits * deps: kleur * chore: add back import.meta.glob handling as deprecated * docs: bump down to `minor`, update headline to be less content collections-y * typo: suggest adding * chore: support URL object on `site` * docs: add await to pagesGlob ex * docs: tighten `rssSchema` explainer * docs: tighten pagesGlobToRssItems section * docs: add content to README * docs: replace examples with docs link * docs: re-we Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca> Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
41 lines
1.1 KiB
Markdown
41 lines
1.1 KiB
Markdown
---
|
|
'@astrojs/rss': minor
|
|
---
|
|
|
|
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:
|
|
|
|
```diff
|
|
// 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:
|
|
|
|
```ts
|
|
import { defineCollection } from 'astro:content';
|
|
import { rssSchema } from '@astrojs/rss';
|
|
|
|
const blog = defineCollection({
|
|
schema: rssSchema,
|
|
});
|
|
|
|
export const collections = { blog };
|
|
```
|