Improve default template download speed (#12154)

.changeset/curvy-bikes-sing.md

@@ -0,0 +1,5 @@
+---
+'create-astro': minor
+---
+
+Improves default template download speed by downloading from a branch containing the template only

.github/workflows/sync-examples.yml

@@ -40,11 +40,13 @@ jobs:
       # We only do sync if there are no changesets, so we don't accidentally allow users
       # to clone examples that may rely on unreleased code
 
-      - name: Sync from main branch to latest branch
+      - name: Sync from main branch to latest and examples/* branches
         if: steps.detect.outputs.has-changesets == 'false' && github.ref == 'refs/heads/main'
         uses: bluwy/auto-branch-sync-action@v1
         with:
-          map: / -> latest
+          map: |
+            / -> latest
+            /examples/* -> examples/*
           skip-unchanged-check: ${{ inputs.skip-unchanged-check == true }}
           dry-run: ${{ inputs.dry-run == true }}
 

examples/hackernews/.gitignore

@@ -1,6 +1,5 @@
 # build output
 dist/
-.output/
 # generated types
 .astro/
 
@@ -20,3 +19,6 @@ pnpm-debug.log*
 
 # macOS-specific files
 .DS_Store
+
+# jetbrains setting folder
+.idea/

examples/integration/.gitignore

@@ -0,0 +1,24 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# jetbrains setting folder
+.idea/

examples/middleware/.gitignore

@@ -0,0 +1,24 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# jetbrains setting folder
+.idea/

examples/server-islands/.gitignore

@@ -0,0 +1,24 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# jetbrains setting folder
+.idea/

examples/ssr/.gitignore

@@ -0,0 +1,24 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# jetbrains setting folder
+.idea/

examples/starlog/.gitignore

@@ -0,0 +1,24 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# jetbrains setting folder
+.idea/

examples/view-transitions/.gitignore

@@ -0,0 +1,24 @@
+# build output
+dist/
+# generated types
+.astro/
+
+# dependencies
+node_modules/
+
+# logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+
+# environment variables
+.env
+.env.production
+
+# macOS-specific files
+.DS_Store
+
+# jetbrains setting folder
+.idea/

packages/create-astro/src/actions/template.ts

@@ -72,13 +72,25 @@ const FILES_TO_UPDATE = {
 };
 
 export function getTemplateTarget(tmpl: string, ref = 'latest') {
+	// Handle Starlight templates
 	if (tmpl.startsWith('starlight')) {
 		const [, starter = 'basics'] = tmpl.split('/');
-		return `withastro/starlight/examples/${starter}`;
+		return `github:withastro/starlight/examples/${starter}`;
 	}
+
+	// Handle third-party templates
 	const isThirdParty = tmpl.includes('/');
 	if (isThirdParty) return tmpl;
+
+	// Handle Astro templates
+	if (ref === 'latest') {
+		// `latest` ref is specially handled to route to a branch specifically
+		// to allow faster downloads. Otherwise giget has to download the entire
+		// repo and only copy a sub directory
+		return `github:withastro/astro#examples/${tmpl}`;
+	} else {
 		return `github:withastro/astro/examples/${tmpl}#${ref}`;
+	}
 }
 
 export default async function copyTemplate(tmpl: string, ctx: Context) {
@@ -88,7 +100,6 @@ export default async function copyTemplate(tmpl: string, ctx: Context) {
 		try {
 			await downloadTemplate(templateTarget, {
 				force: true,
-				provider: 'github',
 				cwd: ctx.cwd,
 				dir: '.',
 			});