feat(cli): add support for remote templates with --template
#7867
+11,244
−13,726
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
Co-authored-by: Espen Hovlandsdal <espen@hovlandsdal.com>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Skipped Deployment
|
RostiMelk
changed the title
--template --template
|
No changes to documentation |
|
Component Testing Report Updated Nov 25, 2024 3:23 PM (UTC) ✅ All Tests Passed -- expand for details
|
⚡️ Editor Performance ReportUpdated Mon, 25 Nov 2024 15:25:10 GMT
Detailed information🏠 Reference resultThe performance result of
🧪 Experiment resultThe performance result of this branch
📚 Glossary
|
RostiMelk
commented
Nov 25, 2024
| '--dataset', | ||
| testRunArgs.dataset, | ||
| '--template', | ||
| 'https://github.com/SimeonGriggs/sanity-remix-template', |
There was a problem hiding this comment.
Need to replace this with something on our org
RostiMelk
commented
Nov 29, 2024
| @@ -1117,6 +1093,58 @@ export default async function initSanity( | |||
| }) | |||
| } | |||
|
|
|||
| async function updateProjectCliInitializedMetadata() { | |||
There was a problem hiding this comment.
These were defined in an array of promises. I've just defined them further down in the code as functions, but still call them in the same place as we did previously. See L622 & L623
RostiMelk
commented
Nov 29, 2024
| @@ -0,0 +1,9 @@ | |||
| import {type SanityUser} from '../types' | |||
|
|
|||
| export function getProviderName(provider: SanityUser['provider']) { | |||
There was a problem hiding this comment.
Using this for intro message
svirs
reviewed
Nov 30, 2024
| pathSegments.length >= 2 && | ||
| (pathSegments.length > 2 ? pathSegments[2] === 'tree' && pathSegments.length >= 4 : true) | ||
| ) | ||
| } catch (_) { |
There was a problem hiding this comment.
If unused we can decide to not bind an error:
catch { ...
svirs
reviewed
Nov 30, 2024
|
|
||
| const INITIAL_COMMIT_MESSAGE = 'Initial commit from Sanity CLI' | ||
|
|
||
| export async function bootstrapRemoteTemplate( |
There was a problem hiding this comment.
Clearly seeing the pipeline of things that need to be done serially here but unsure how failure of this half-way would look. We have a pattern of showing the error messages in the cli but if this partially completes, it might be confusing to users to know how to proceed if they have the repo down but were unable to have any of the files edited. Perhaps some try/catch around groups of this where the errors are still thrown to be printed on the cli but have some surrounding context like "Unable to edit newly downloaded files in [folder]/. See documentation on updating files from a template: some-docs link" or something else could be helpful in getting people un-stuck at certain points.
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.
Introducing Support for Remote Templates in
--templateFlagWhat is a remote template?
A remote template is really any GitHub repo that passes a given set of requirements.
The requirements are:
Monorepo Repositories
package.json
package.json.sanityin itsdependenciesordevDependencies.Sanity Configuration Files
sanity.config.js/tsandsanity.cli.js/ts.Environment Template Files
.env.template.env.example.env.local.exampleSingle-Package Repositories
package.json
package.jsonwithsanitylisted independenciesordevDependencies.Sanity Configuration Files
sanity.config.js/tsandsanity.cli.js/ts.Environment Template File
.env.template.env.example.env.local.exampleEnvironment Variables
For both monorepos and single-package repositories, the environment file must include in all packages:
SANITY_PROJECT_IDorSANITY_STUDIO_PROJECT_IDSANITY_DATASETorSANITY_STUDIO_DATASETIf any of these criteria are not met, the validation will fail with a detailed error message.
What to review
--templateflag works for both built in schema type templates and remote templatesTesting
Shorthand Example
GitHub URL
Nested Directory in a Repository
Notes for release
No notes afaik for now