fix(cli): do not throw during migrate if project ID is passed through flag #7594
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 Skipped Deployment
|
ryanbonial
force-pushed
the
SDK-6
branch
2 times, most recently
from
a89c1aa to
8149b70
Compare
…the --project option instead of the cli config
ryanbonial
changed the title
|
No changes to documentation |
|
Component Testing Report Updated Oct 5, 2024 2:25 PM (UTC) ✅ All Tests Passed -- expand for details
|
ryanbonial
commented
Oct 4, 2024
| @@ -164,9 +164,15 @@ const runMigrationCommand: CliCommandDefinition<CreateFlags> = { | |||
|
|
|||
| const projectConfig = apiClient({ | |||
| requireUser: true, | |||
| requireProject: true, | |||
| requireProject: false, | |||
There was a problem hiding this comment.
I left this in as false instead of removing it so that it would indicate that false is intended here.
⚡️ Editor Performance ReportUpdated Sat, 05 Oct 2024 14:37:11 GMT
Detailed information🏠 Reference resultThe performance result of
🧪 Experiment resultThe performance result of this branch
📚 Glossary
|
rexxars
changed the title
rexxars
requested changes
Oct 5, 2024
packages/sanity/src/_internal/cli/commands/migration/runMigrationCommand.ts
Outdated
Show resolved
Hide resolved
Co-authored-by: Espen Hovlandsdal <espen@hovlandsdal.com>
rexxars
approved these changes
Oct 5, 2024
bjoerge
pushed a commit
that referenced
this pull request
Oct 7, 2024
… flag (#7594) ### Description This PR sets the `apiClient`'s `requireProject` to `false` and instead only throws an error if both the cli config and the `--project` option are missing ### What to review Verify that the change is as expected and that the wording of the error is correct. ### Testing * create a simple migration script with sanity, `sanity migration create` and follow the prompt make sure there is no `sanity.cli.js` in your codebase Next steps: * Open /code/migrations/migration_id/index.ts in your code editor and write the code for your migration. * Dry run the migration with: `sanity migration run migration_id --project= --dataset` * Run the migration against a dataset with: `sanity migration run migration_id --project= --dataset --no-dry-run` * edit the script and run it as: `sanity migration run migration_id --project=real_project_id --dataset real_dataset` you should NOT get an error. Test again without specifying a `--project` project ID, you should see an error. ### Notes for release None <!-- Engineers do not need to worry about the final copy, but they must provide the docs team with enough context on: * What changed * How does one use it (code snippets, etc) * Are there limitations we should be aware of If this is PR is a partial implementation of a feature and is not enabled by default or if this PR does not contain changes that needs mention in the release notes (tooling chores etc), please call this out explicitly by writing "Part of feature X" or "Not required" in this section. --> --------- Co-authored-by: Espen Hovlandsdal <espen@hovlandsdal.com>
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
This PR sets the
apiClient'srequireProjecttofalseand instead only throws an error if both the cli config and the--projectoption are missingWhat to review
Verify that the change is as expected and that the wording of the error is correct.
Testing
sanity migration createand follow the promptmake sure there is no
sanity.cli.jsin your codebaseNext steps:
Open /code/migrations/migration_id/index.ts in your code editor and write the code for your migration.
Dry run the migration with:
sanity migration run migration_id --project= --datasetRun the migration against a dataset with:
sanity migration run migration_id --project= --dataset --no-dry-runedit the script and run it as:
sanity migration run migration_id --project=real_project_id --dataset real_datasetyou should NOT get an error.
Test again without specifying a
--projectproject ID, you should see an error.Notes for release
None