feat: implement create site from template feature #3948

charliegerard · 2022-01-04T22:57:05Z

Summary

There's a new feature in the UI to start a site from a template that I think should also be available via the CLI so this PR implements this feature 🙂

FYI, I re-used a lot of the code already written for the sites:create command.

Related to #3947

PR test plan:

Check the update to the docs site
When running the command netlify sites:create-template, you should be prompted to pick a template out of the ones currently available (Next.js blog theme, Next.js starter, Nuxt, Hugo).
Step 2 should be asking to pick a team and list the current user's teams.
Step 3 should be asking you to log into GitHub either via the Netlify UI or by entering a GitHub token.
When authenticated with GitHub, step 4 should ask you to enter a site name, if you pick a name that already exists as a repo on your github account, it should ask you to pick another one.
If you picked a unique name, it should succeed, create a repo in your Github account, a site on Netlify and the CLI should show you the links to the site and repo.
If you don't input a site name, it should pick a random one and assign it to both the repo and site.

For us to review and ship your PR efficiently, please perform the following steps:

Open a bug/issue before writing your code 🧑‍💻. This ensures we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a typo or something that`s on fire 🔥 (e.g. incident related), you can skip this step.
Read the contribution guidelines 📖. This ensures your code follows our style guide and
passes our tests.
Update or add documentation (if features were changed or added) 📝
Make sure the status checks below are successful ✅

A picture of a cute animal (not mandatory, but encouraged)

github-actions · 2022-01-04T22:57:40Z

📊 Benchmark results

Comparing with 127a1c6

Package size: 368 MB

⬇️ 0.00% decrease vs. 127a1c6

^  363 MB  362 MB  363 MB  363 MB  363 MB  362 MB  363 MB  363 MB  362 MB  362 MB  361 MB  361 MB  368 MB 
│   ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐    ┌──┐  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
│   |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |  |    |▒▒|  
└───┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴────┴──┴──>
    T-12    T-11    T-10    T-9     T-8     T-7     T-6     T-5     T-4     T-3     T-2     T-1      T

Legend

T-30 (127a1c6): 368 MB
T-29 (12713ca): 368 MB
T-28 (6424921): 368 MB
T-27 (9902ec0): 368 MB
T-26 (fb4fd7a): 368 MB
T-25 (b557a4d): 368 MB
T-24 (d7d1a83): 368 MB
T-23 (5aada1e): 368 MB
T-22 (db86f16): 363 MB
T-21 (89ec45c): 363 MB
T-20 (e6bde5b): 363 MB
T-19 (8a59a03): 363 MB
T-18 (501da79): 363 MB
T-17 (c370149): 362 MB
T-16 (0e0502c): 362 MB
T-15 (effffec): 362 MB
T-14 (0577c15): 363 MB
T-13 (3dd9f74): 363 MB
T-12 (c32fa07): 363 MB
T-11 (32714f0): 362 MB
T-10 (5b5b360): 363 MB
T-9 (46374c4): 363 MB
T-8 (db0f1ed): 363 MB
T-7 (474118d): 362 MB
T-6 (045326c): 363 MB
T-5 (49708c2): 363 MB
T-4 (fa43ab8): 362 MB
T-3 (4ffba32): 362 MB
T-2 (fc1c991): 361 MB
T-1 (a7c6aab): 361 MB
T (current commit): 368 MB

charliegerard · 2022-01-26T23:59:42Z

@maxcell & @tzmanics adding you as reviewers if you wanna give it a try 🙂

lukasholzer

Thanks for contributing such an awesome feature 🐳 Overall a very nice done PR! Only some minor changes.

Can you please add a small unit test with ava that mocks the api requests away but tests the flow of this command?
Even though it is beta but beta often moves to prod by just removing the word beta 😂

src/commands/sites/sites-create-template.js

lukasholzer · 2022-01-27T09:32:59Z

src/commands/sites/sites-create-template.js

+      console.log(
+        `Choose a unique site name (e.g. ${siteSuggestion}.netlify.app) or leave it blank for a random name. You can update the site name later.`,
+      )
+      const { name: nameInput } = await inquirer.prompt([


is there a possibility to skip that input if it is optional?

That was mostly copied from the sites:create command. I think in general i'd wanna give people the choice to pick a title or not?

src/commands/sites/sites-create-template.js

erezrokah

Thanks @charliegerard and @lukasholzer, I added a few comments of my own too

src/commands/sites/sites-create-template.js

erezrokah · 2022-01-28T14:08:34Z

src/commands/sites/sites-create-template.js

+          throw new Error('Duplicate repo')
+        }
+      } else {
+        site = await api.createSiteInTeam({


This will create the site, but does not set up the CI part. Meaning a commit to the repo won't trigger a build on Netlify.
See

cli/src/commands/sites/sites-create.js

Line 127 in 40b1cf9

if (options.withCi) {

if we want the behavior to configure GitHub as well

charliegerard · 2022-02-01T00:01:49Z

Thanks for the feedback @lukasholzer & @erezrokah! Working through it now and will ask for another review soon, thanks!

charliegerard · 2022-02-03T18:12:25Z

src/commands/sites/sites-create.js

+
+  return name
+}
+


These changes are only to be able to extract the piece of code that is reused in the sites-create-template.js file to avoid duplication, the logic isn't changed

charliegerard · 2022-02-03T18:16:57Z

tests/integration/140.command.sites.test.js

+ */
+
+test.skip('netlify sites:create-template', async (t) => {
+  const siteTemplateQuestions = [


@lukasholzer I tried to add some tests for this command but I've been struggling and could do with some guidance on how to mock the API calls to Github if you have some idea or if you know somewhere else in the code I should look at, please? 🙏 I tried using sinon and also nock but didn't manage to make it work 😞

For now I skipped these tests cause they ping the real Github API.

Hey @charliegerard I've added a commit showcasing how to mock the github api – so you should good to go writing the test.

The problem you faced was that it is impossible to mock something that is spawned in a child process -> what you do by calling execa -> basically a wrapper over child_process spawn.

So the cool thing is that you can start up a command without invoking it as a child process and then you achieve ultimate power of having the same global context and therefore mocking things out.

The only importance is that you need to do the mocks before you require the actual code. As it needs to patch the functions first with the stubbed logic.

I hope you are good to go now :) otherwise don't hesitate to reach out to me maybe we can do a 🍐 on that if it helps you!

Here the commit: aee0ff5

Awesome, thank you so much! I'll have a look!

charliegerard · 2022-02-03T18:19:09Z

@lukasholzer & @erezrokah I think I implemented most of the feedback, the main thing missing is around the tests that I've been having some issues with. Let me know what you think!

Also, i'm not sure i understand why this check fails 🤔.

I also added the --with-ci option but it doesn't seem to work, I think i'm confused with the step asking to provide the SSH URL of the remote repo. Even when i do, the deploy fails and it's marking deploys as manual :/

charliegerard · 2022-02-07T06:41:09Z

@lukasholzer I added some tests so this PR should be ready for review again 🙂 Thanks!

lukasholzer

Thank you so much for adding the tests and improving our overall test coverage 💯 This deserves a big 🐬 for awesomeness! 🚀

erezrokah

This looks greats @charliegerard 🚀 That you for following up with everything.

Added a few non blocking comments.

src/commands/sites/sites-create-template.js

erezrokah · 2022-02-07T17:33:23Z

@charliegerard I re-approved so you can add automerge when you're ready

charliegerard · 2022-02-07T17:44:42Z

@erezrokah Thanks so much! Do I need to rename the branch or anything? Looking at the contributing file, it says to have a branch named releases/<tag>/<version>. If not, I'll just enable auto-merge 😃

erezrokah · 2022-02-07T21:15:55Z

@erezrokah Thanks so much! Do I need to rename the branch or anything? Looking at the contributing file, it says to have a branch named releases/<tag>/<version>. If not, I'll just enable auto-merge

That's for pre-releases. For official releases once you merge a PR, a release PR is generated.
See #4207. Once the release PR is merged a new release is published.

I took the liberty of merging an releasing this in #4207

github-actions bot added the type: feature code contributing to the implementation of a feature and/or user facing functionality label Jan 4, 2022

charliegerard force-pushed the cg/addCreateSitesFromTemplateFeature branch 2 times, most recently from 3022af0 to e79b826 Compare January 12, 2022 01:13

charliegerard marked this pull request as ready for review January 26, 2022 23:59

charliegerard requested a review from a team as a code owner January 26, 2022 23:59

charliegerard requested review from maxcell and tzmanics January 26, 2022 23:59

lukasholzer suggested changes Jan 27, 2022

View reviewed changes

erezrokah suggested changes Jan 28, 2022

View reviewed changes

charliegerard added 14 commits February 3, 2022 10:02

feat: implement create site from template feature

1889a4b

chore: improve experience and add some error handling

d3a6e33

fix: syntax error

2a055b2

feat: finish implementing start with template

f65ca3a

chore: small improvement

64f0afa

feat: add option to pass template url

9901dc0

feat: generate docs

659dca0

feat: handle more generic error

541782c

chore: implement feedback

c44df7f

feat: fetch templates from github and add ci option

3783d32

chore: starting to add a test

d4e0521

chore: update test

37e8139

chore: refactor

f5e5799

chore: rename test file

1204098

charliegerard force-pushed the cg/addCreateSitesFromTemplateFeature branch from 00f1991 to 1204098 Compare February 3, 2022 18:09

charliegerard commented Feb 3, 2022

View reviewed changes

charliegerard requested a review from lukasholzer February 3, 2022 18:17

charliegerard requested a review from erezrokah February 3, 2022 18:17

charliegerard and others added 7 commits February 3, 2022 14:13

fix: fix bug with site name

5fe7ad8

feat: add repo SSH url for easier CI setup

a8bc3df

chore: remove

786f1e2

Merge branch 'main' into cg/addCreateSitesFromTemplateFeature

72425d0

test: show how to propperly mock the github api

aee0ff5

feat: add tests

3fd796c

feat: throw error if url passed is invalid

e80ef0f

lukasholzer previously approved these changes Feb 7, 2022

View reviewed changes

erezrokah previously approved these changes Feb 7, 2022

View reviewed changes

src/commands/sites/sites-create-template.js Outdated Show resolved Hide resolved

src/commands/sites/sites-create-template.js Outdated Show resolved Hide resolved

src/commands/sites/sites-create-template.js Outdated Show resolved Hide resolved

chore: implement feedback

c8607a8

charliegerard dismissed stale reviews from erezrokah and lukasholzer via c8607a8 February 7, 2022 17:13

erezrokah approved these changes Feb 7, 2022

View reviewed changes

lukasholzer added the automerge Add to Kodiak auto merge queue label Feb 7, 2022

Merge branch 'main' into cg/addCreateSitesFromTemplateFeature

26666e4

lukasholzer approved these changes Feb 7, 2022

View reviewed changes

kodiakhq bot merged commit 3ebfea9 into main Feb 7, 2022

kodiakhq bot deleted the cg/addCreateSitesFromTemplateFeature branch February 7, 2022 18:26

token-generator-app bot mentioned this pull request Feb 7, 2022

chore(main): release 8.18.0 #4207

Merged

sgrove mentioned this pull request Feb 8, 2022

feat: additional graph commands, extra graph codegen tests, and type definitions #4186

Merged

3 tasks

anmonteiro mentioned this pull request Feb 8, 2022

fix: integration tests #4213

Closed

5 tasks

token-generator-app bot mentioned this pull request May 26, 2022

chore(main): release 10.3.3 #4629

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: implement create site from template feature #3948

feat: implement create site from template feature #3948

charliegerard commented Jan 4, 2022 •

edited

Loading

github-actions bot commented Jan 4, 2022 •

edited

Loading

charliegerard commented Jan 26, 2022

lukasholzer left a comment

lukasholzer Jan 27, 2022

charliegerard Feb 1, 2022

erezrokah left a comment

erezrokah Jan 28, 2022

charliegerard commented Feb 1, 2022

charliegerard Feb 3, 2022

charliegerard Feb 3, 2022

lukasholzer Feb 4, 2022

lukasholzer Feb 4, 2022

charliegerard Feb 4, 2022

charliegerard commented Feb 3, 2022 •

edited

Loading

charliegerard commented Feb 7, 2022

lukasholzer left a comment

erezrokah left a comment

erezrokah commented Feb 7, 2022

charliegerard commented Feb 7, 2022

erezrokah commented Feb 7, 2022

feat: implement create site from template feature #3948

feat: implement create site from template feature #3948

Conversation

charliegerard commented Jan 4, 2022 • edited Loading

Summary

PR test plan:

github-actions bot commented Jan 4, 2022 • edited Loading

📊 Benchmark results

Package size: 368 MB

charliegerard commented Jan 26, 2022

lukasholzer left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

erezrokah left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

charliegerard commented Feb 1, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

charliegerard commented Feb 3, 2022 • edited Loading

charliegerard commented Feb 7, 2022

lukasholzer left a comment

Choose a reason for hiding this comment

erezrokah left a comment

Choose a reason for hiding this comment

erezrokah commented Feb 7, 2022

charliegerard commented Feb 7, 2022

erezrokah commented Feb 7, 2022

charliegerard commented Jan 4, 2022 •

edited

Loading

github-actions bot commented Jan 4, 2022 •

edited

Loading

charliegerard commented Feb 3, 2022 •

edited

Loading