-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
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
feat: add sync
variant
#11729
feat: add sync
variant
#11729
Conversation
🦋 Changeset detectedLatest commit: d5ba3eb 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.
This PR is blocked because it contains a minor
changeset. A reviewer will merge this at the next release if approved.
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.
LGTM, may break a few integrations
How? :| Maybe because they use a |
yes, command have been holding 3 possible values for so long that maybe some conditions will be broken. That being said, I don't see a better way than this so up to integrations authors to update |
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.
Quick suggestion for the changeset @ematipico ! When something new is added, I always like starting with "Adds" because that's the biggest clue that this is new, something you could check out, but not necessary and shouldn't break anything.
Also, I saw the conversation here about whether or not some projects might be relying on the fact that there have been exactly three options previously. If you felt it was necessary or helpful, you could consider adding another paragraph with a single line just saying something like:
If your integration previously relied on knowing how many variants existed for the `command` property, you must update your logic to account for this new option.
if you feel like that's a common enough thing!
I think it's useful to add such paragraph |
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
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.
Approving for docs!
Changes
Closes #10876
I added a
"sync"
variant to the command. This will be useful to the extension too.This is flagged as minor, because it adds new information.
Testing
Existing CI should pass. Should I create a test? 🤔
Docs
withastro/docs#9110