-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
Stabilize live collections #14550
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.
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
Stabilize live collections #14550
Conversation
🦋 Changeset detectedLatest commit: 6170318 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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love to see such a small PR!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! And if anything gets a pass at not being a minimal changeset, it's this one! (It won't really be in the upgrade guide at all other than removing the experimental flag, so it should shine here.)
Some tiny comments below!
Co-authored-by: Yan <[email protected]> Co-authored-by: Sarah Rainsberger <[email protected]>
.changeset/stale-ads-see.md
Outdated
| }); | ||
| ``` | ||
|
|
||
| No other changes to your project code are required as long as you have been keeping up with Astro 5.x patch releases which may have contained breaking changes to this experimental feature. If you experience problems with your live collections after upgrading to Astro v6 and removing this flag, please review the [Astro CHANGELOG from 5.10.2](https://github.com/withastro/astro/blob/main/packages/astro/CHANGELOG.md#5102) onwards for any potential updates you might have missed, or follow the [current v6 documentation for live collections](https://docs.astro.build/en/guides/content-collections/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
may have contained breaking changes to this experimental feature
What do we mean by "may"? We don't know if there were breaking changes to the feature? I feel like we could be clearer here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's fair! I think I saw an update in 5.10.2 (so you no longer specify a live type of collection) and there's a current breaking change PR we just reviewed (not sure if going out in a 5.14 patch, or will wait for 5.15.0) that for sure is a breaking change).
This is kind of generic language, because I also don't know what other breaking changes might come up between now and then. But in fact, we could just take out the words "may have" and it would be correct!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed the "may have". There were breaking changes in some of them.
Co-authored-by: Yan <[email protected]>
Updated the note regarding changes required for Astro 6.
|
@sarah11918 does this need anything for docs approval? It'd be good to merge it into |
|
The changeset looks good to me! Maybe this was waiting for a section to exist in docs to link to (ie. #14550 (comment))? But I guess we can always update the changeset later. So, it should be safe to merge I think. Kinda related to stabilizing live collections, when checking the imports to document the import type {
LiveDataCollection,
LiveDataCollectionResult,
LiveDataEntry,
LiveDataEntryResult,
} from "astro";Since we have Is there a reason for those imports to be exported from |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just two thoughts left here on the changeset. (Acknowledging that the corresponding docs PR means rewriting the entire content collections guide, so will take some time! But no need to wait for that before this PR merges.)
Will also note Armand's comments that will affect documenting alongside (or not?) astro:content should also be resolved, but I'm approving the changeset, and saying we don't have to wait for all the docs on this topic to be done!
Co-authored-by: Sarah Rainsberger <[email protected]>
|
What is missing to get this merged? |
|
Sarah approved this, and I got an answer to my question from Matt in another PR:
So, nothing blocking from docs! Ideally, some types should be moved, but that doesn't need to be done here or now! |
Changes
Removes the
experimental.liveContentCollectionsflag and enables it for all sites.Closes #14376
Testing
Updated test fixture
Docs
Added changeset. It doesn't have any links to docs, because I'm not sure where they'll live.
EDITED BY SARAH:
@withastro/maintainers-docs