Skip to content

fix: updates types for live collection entries #14548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Oct 16, 2025
Merged

fix: updates types for live collection entries #14548

merged 3 commits into from
Oct 16, 2025

Conversation

ascorbic
Copy link
Contributor

@ascorbic ascorbic commented Oct 16, 2025 •
edited
Loading

Changes

  • Adds the missing rendered property to live entries. This is documented and functional, but was missing from types
  • Removes the cacheHint.maxAge property. From feedback and observing usage, this doesn't make sense to be set by the loader. The max age is something that the user should choose, and isn't information that the loader has. This is a breaking change in the types, but it is an experimental feature so can go in a patch.

Testing

Updated the tests, and added a new test for entry rendering

Docs

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Oct 16, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: 975b375

The changes in this PR will be included in the next version bump.

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) docs pr labels Oct 16, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 16, 2025 •
edited
Loading

📝 Changeset Validation Results

❌ Changeset validation failed

Issues Found:

.changeset/plain-women-double.md

Issue with: '#### ⚠️ Breaking change for live content collections only'

❌ Errors:
• Incorrect heading level used (####). This breaks the changelog rendering.
• Use a text description or use ##### instead.

💡 Replace #### :warning: Breaking change for live content collections only with ##### :warning: Breaking change for live content collections only.

Issue with: 'Removes support for the maxAge property in cacheHint objects returned by live loaders.'

❌ The description indicates a breaking change, which is inconsistent with the declared change type patch.

General Errors:

  • Invalid formatting: Change type patch cannot contain breaking changes.

General Suggestions:

  • Ensure breaking changes are assigned a major change type and provide detailed migration advice.

📖 See Astro's changeset guide for details.

@codspeed-hq CodSpeed HQ
Copy link

codspeed-hq bot commented Oct 16, 2025 •
edited
Loading

CodSpeed Performance Report

Merging #14548 will not alter performance

Comparing live-collection-types (975b375) with main (62ec8ea)1

Summary

✅ 6 untouched

Footnotes

  1. No successful run was found on main (4632db3) during the generation of this report, so 62ec8ea was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

@ascorbic ascorbic mentioned this pull request Oct 16, 2025
Merged
sarah11918
sarah11918 reviewed Oct 16, 2025
View reviewed changes
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Two tiny, non-blocking thoughts below for your consideration!

@ascorbic @sarah11918
Apply suggestions from code review
975b375 
Co-authored-by: Sarah Rainsberger <[email protected]>
sarah11918
sarah11918 approved these changes Oct 16, 2025
View reviewed changes
Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving for docs!

@ascorbic ascorbic merged commit 6cdade4 into main Oct 16, 2025
22 of 23 checks passed
@ascorbic ascorbic deleted the live-collection-types branch October 16, 2025 13:22
@astrobot-houston astrobot-houston mentioned this pull request Oct 16, 2025
Merged
richardnbanks pushed a commit to richardnbanks/astro-loader-youtube that referenced this pull request Oct 19, 2025
@richardnbanks
chore(deps): update npm (#21)
2700191 
This PR contains the following updates:

| Package | Change | Age | Confidence |
|---|---|---|---|
| [astro](https://astro.build) ([source](https://github.com/withastro/astro/tree/HEAD/packages/astro)) | [`5.14.5` -> `5.14.6`](https://renovatebot.com/diffs/npm/astro/5.14.5/5.14.6) | [![age](https://developer.mend.io/api/mc/badges/age/npm/astro/5.14.6?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/astro/5.14.5/5.14.6?slim=true)](https://docs.renovatebot.com/merge-confidence/) |

---

### Release Notes

<details>
<summary>withastro/astro (astro)</summary>

### [`v5.14.6`](https://github.com/withastro/astro/blob/HEAD/packages/astro/CHANGELOG.md#5146)

[Compare Source](https://github.com/withastro/astro/compare/[email protected]@5.14.6)

##### Patch Changes

- [#&#8203;14562](withastro/astro#14562) [`722bba0`](withastro/astro@722bba0) Thanks [@&#8203;erbierc](https://github.com/erbierc)! - Fixes a bug where the behavior of the "muted" HTML attribute was inconsistent with that of other attributes.

- [#&#8203;14538](withastro/astro#14538) [`51ebe6a`](withastro/astro@51ebe6a) Thanks [@&#8203;florian-lefebvre](https://github.com/florian-lefebvre)! - Improves how Actions are implemented

- [#&#8203;14548](withastro/astro#14548) [`6cdade4`](withastro/astro@6cdade4) Thanks [@&#8203;ascorbic](https://github.com/ascorbic)! - Removes support for the `maxAge` property in `cacheHint` objects returned by live loaders.

##### ⚠️ Breaking change for experimental live content collections only

Feedback showed that this did not make sense to set at the loader level, since the loader does not know how long each individual entry should be cached for.

If your live loader returns cache hints with `maxAge`, you need to remove this property:

```diff
return {
  entries: [...],
  cacheHint: {
    tags: ['my-tag'],
-   maxAge: 60,
    lastModified: new Date(),
  },
};
```

The `cacheHint` object now only supports `tags` and `lastModified` properties. If you want to set the max age for a page, you can set the headers manually:

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0MS45OS4xMSIsInVwZGF0ZWRJblZlciI6IjQxLjk5LjExIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119-->

Reviewed-on: https://code.richardbanks.dev/richard/astro-loader-youtube/pulls/21
Co-authored-by: Renovate Bot <[email protected]>
Co-committed-by: Renovate Bot <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ematipico ematipico ematipico approved these changes

@sarah11918 sarah11918 sarah11918 approved these changes

Assignees

No one assigned

Labels

docs pr pkg: astro Related to the core `astro` package (scope)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ascorbic @ematipico @sarah11918