-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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: change default value of checkOrigin
#11788
Conversation
🦋 Changeset detectedLatest commit: e1902a0 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 major
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.
Thanks @ematipico ! This was one I already had started an entry for in the upgrade guide, so you can also review the entry in the guide here and adjust it as you see fit.
You will also need to update the types/public/config.ts
file changing the default in the @docs
entry to true
. I would also remove the "when enabled" from the start of the sentence and just start with "Performs a check...." since that's now the default behaviour.
That should probably be changed in this PR at the same time. (I think it's fine to keep the version number of the feature at 4.9 though, even though the default value has now changed.)
I like how you showed adding the opt-out, whereas my entry showed removing the 'true' setting as no longer needed. Either one is fine by me, whatever you prefer!
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.
Code-wise looks good 👍
9c34209
to
72982b6
Compare
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 @ematipico ! Approving for docs! 🥳
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
Changes
Closes PLT-2262
It changes the value of
security.checkOrigin
totrue
Testing
I updated the existing tests and removed the config. Tests should still pass
Docs
N/A
/cc @withastro/maintainers-docs for feedback!