feat(import): add --allow-system-documents to dataset import #5689
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
|
No changes to documentation |
|
Component Testing Report Updated Feb 8, 2024 7:07 PM (UTC)
|
j33ty
force-pushed
the
radhe/cldx-1593-include-system-docs
branch
from
61523e2
to
a2bb259
Compare
j33ty
force-pushed
the
radhe/cldx-1593-include-system-docs
branch
from
a2bb259
to
920ca1c
Compare
j33ty
force-pushed
the
radhe/cldx-1593-include-system-docs
branch
from
920ca1c
to
dc96361
Compare
… to explicitly permit system document import, which should be ignore otherwise
j33ty
force-pushed
the
radhe/cldx-1593-include-system-docs
branch
from
dc96361
to
3e12256
Compare
j33ty
requested review from
bjoerge,
rneatherway and
codebymatt
and removed request for
a team
j33ty
changed the title
rneatherway
approved these changes
Feb 9, 2024
IMO taking away a functionality without a fallback option isn't a good experience. Enterprise folks with custom group documents may want to import system documents and with a flag, they can continue importing them. |
binoy14
approved these changes
Feb 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
As part of the import process through CLI and
@sanity/importpackage, we prefer that users do not send in system documents. These documents are considering to be an internal detail and if imported, their interaction with existing system documents is undefined.This PR attempts at adding a new flag
--allow-system-documentstosanity dataset importCLI and an optionallowSystemDocumentto@sanity/importpackage, to explicitly permit system document import if the user knows what they are doing.This can be considered to be a breaking change since it by default skips system documents from import, but I highly doubt anyone is importing system documents from CLI. And, if they are, they should stop doing that. Ideally, I should add data to my gut-feeling and figure out how many users are importing system documents directly from CLI but it's not trivial to get these numbers. Let me know if this needs to be done.
Background for change is present in #prj-dataset-backups.
Bikeshedding
Two appropriate names for the flag are
--import-system-documentsor--allow-system-documents. I have weak preference for the latter since it aligns with existing options on the same subcommand.Testing
Two unit tests are added where import with and without this flag is tested.
Notes for Release
It should okay to add commit message as it is to release notes.