feat(cli): remove .github dirs when initializing with a remote template

[RostiMelk]

Description

Filter away .github directories when initializing with a remote template. This is to prevent potential security risks from running unknown actions if the user decides to push their project to GitHub

Fixes GRO-3053

Questions

Are there any more directories we should omit?

Testing

Run

sanity init --template sanity-io/sanity-template-nextjs-clean

See if the directory includes a .github folder

Notes for release

N/A

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
page-building-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 13, 2024 1:27pm
performance-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 13, 2024 1:27pm
test-next-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 13, 2024 1:27pm
test-studio	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 13, 2024 1:27pm

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
studio-workshop	⬜️ Ignored (Inspect)	Visit Preview		Dec 13, 2024 1:27pm

[github-actions]

No changes to documentation

[github-actions]

Component Testing Report Updated Dec 13, 2024 1:17 PM (UTC)

❌ Failed Tests (6) -- expand for details

File	Status	Duration	Passed	Skipped	Failed
comments/CommentInput.spec.tsx	✅ Passed (Inspect)	1m 10s	15	0	0
formBuilder/ArrayInput.spec.tsx	✅ Passed (Inspect)	14s	3	0	0
formBuilder/inputs/PortableText/Annotations.spec.tsx	✅ Passed (Inspect)	40s	6	0	0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx	✅ Passed (Inspect)	56s	11	7	0
formBuilder/inputs/PortableText/copyPaste/CopyPasteFields.spec.tsx	✅ Passed (Inspect)	0s	0	12	0
formBuilder/inputs/PortableText/Decorators.spec.tsx	✅ Passed (Inspect)	28s	6	0	0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx	✅ Passed (Inspect)	16s	3	0	0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx	❌ Failed (Inspect)	4m 27s	0	0	6
formBuilder/inputs/PortableText/FocusTracking.spec.tsx	✅ Passed (Inspect)	1m 14s	15	0	0
formBuilder/inputs/PortableText/Input.spec.tsx	✅ Passed (Inspect)	3m 4s	21	0	0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx	✅ Passed (Inspect)	1m 47s	18	0	0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx	✅ Passed (Inspect)	14s	3	9	0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx	✅ Passed (Inspect)	42s	9	0	0
formBuilder/inputs/PortableText/Styles.spec.tsx	✅ Passed (Inspect)	29s	6	0	0
formBuilder/inputs/PortableText/Toolbar.spec.tsx	✅ Passed (Inspect)	1m 52s	21	0	0
formBuilder/tree-editing/TreeEditing.spec.tsx	✅ Passed (Inspect)	0s	0	3	0
formBuilder/tree-editing/TreeEditingNestedObjects.spec.tsx	✅ Passed (Inspect)	0s	0	3	0

[github-actions]

⚡️ Editor Performance Report

Updated Fri, 13 Dec 2024 13:25:10 GMT

Benchmark	reference latency of sanity@latest	experiment latency of this branch	Δ (%) latency difference
article (title)	27.8 efps (36ms)	24.4 efps (41ms)	+5ms (+13.9%)	✅
article (body)	72.5 efps (14ms)	71.9 efps (14ms)	+0ms (-/-%)	✅
article (string inside object)	25.6 efps (39ms)	25.6 efps (39ms)	+0ms (-/-%)	✅
article (string inside array)	25.0 efps (40ms)	23.3 efps (43ms)	+3ms (+7.5%)	✅
recipe (name)	52.6 efps (19ms)	52.6 efps (19ms)	+0ms (-/-%)	✅
recipe (description)	58.8 efps (17ms)	58.8 efps (17ms)	+0ms (-/-%)	✅
recipe (instructions)	99.9+ efps (5ms)	99.9+ efps (5ms)	+0ms (-/-%)	✅
synthetic (title)	18.9 efps (53ms)	19.2 efps (52ms)	-1ms (-1.9%)	✅
synthetic (string inside object)	18.5 efps (54ms)	18.3 efps (55ms)	+1ms (+0.9%)	✅

efps — editor "frames per second". The number of updates assumed to be possible within a second.

Derived from input latency. efps = 1000 / input_latency

Detailed information

🏠 Reference result

The performance result of sanity@latest

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	36ms	38ms	40ms	76ms	34ms	12.2s
article (body)	14ms	16ms	18ms	199ms	216ms	5.4s
article (string inside object)	39ms	42ms	47ms	64ms	148ms	6.7s
article (string inside array)	40ms	43ms	51ms	175ms	272ms	7.0s
recipe (name)	19ms	21ms	24ms	43ms	0ms	6.6s
recipe (description)	17ms	19ms	24ms	65ms	0ms	4.6s
recipe (instructions)	5ms	6ms	7ms	12ms	0ms	3.0s
synthetic (title)	53ms	55ms	60ms	336ms	564ms	13.7s
synthetic (string inside object)	54ms	56ms	63ms	262ms	575ms	8.0s

🧪 Experiment result

The performance result of this branch

Benchmark	latency	p75	p90	p99	blocking time	test duration
article (title)	41ms	43ms	49ms	186ms	156ms	11.3s
article (body)	14ms	16ms	18ms	77ms	53ms	4.6s
article (string inside object)	39ms	42ms	45ms	157ms	130ms	6.5s
article (string inside array)	43ms	45ms	47ms	84ms	146ms	7.0s
recipe (name)	19ms	21ms	26ms	44ms	0ms	6.6s
recipe (description)	17ms	18ms	19ms	29ms	0ms	4.4s
recipe (instructions)	5ms	6ms	7ms	9ms	0ms	3.1s
synthetic (title)	52ms	54ms	61ms	302ms	548ms	13.5s
synthetic (string inside object)	55ms	58ms	80ms	571ms	1475ms	9.2s

📚 Glossary

column definitions

• benchmark — the name of the test, e.g. "article", followed by the label of the field being measured, e.g. "(title)".
• latency — the time between when a key was pressed and when it was rendered. derived from a set of samples. the median (p50) is shown to show the most common latency.
• p75 — the 75th percentile of the input latency in the test run. 75% of the sampled inputs in this benchmark were processed faster than this value. this provides insight into the upper range of typical performance.
• p90 — the 90th percentile of the input latency in the test run. 90% of the sampled inputs were faster than this. this metric helps identify slower interactions that occurred less frequently during the benchmark.
• p99 — the 99th percentile of the input latency in the test run. only 1% of sampled inputs were slower than this. this represents the worst-case scenarios encountered during the benchmark, useful for identifying potential performance outliers.
• blocking time — the total time during which the main thread was blocked, preventing user input and UI updates. this metric helps identify performance bottlenecks that may cause the interface to feel unresponsive.
• test duration — how long the test run took to complete.

[juice49]

Looks good to me 🙌. The one thing I'd consider is moving the regex of disallowed paths to a variable or constant. But not a blocker at all.

[juice49]

Nice ✨.