Update GIP docs #11303

lfades · 2020-03-23T20:25:44Z

This PR removes some titles that were added before to the docs of getInitialProps, this is done because search results in titles have a higher priority on our Algolia index, and making a search for getStaticProps / getServerSideProps was resulting in the getInitialProps docs first.

ijjk · 2020-03-23T20:31:49Z

Failing test suites

test/integration/create-next-app/index.test.js

create next app > valid example
create next app > should allow example with GitHub URL
create next app > should allow example with GitHub URL and example-path
create next app > should use --example-path over the file path in the GitHub URL

Expand output

● create next app › valid example

Command failed with exit code 1 (EPERM): node /home/runner/work/next.js/next.js/packages/create-next-app/dist/index.js valid-example --example basic-css

  64 |   it('valid example', async () => {
  65 |     const projectName = 'valid-example'
> 66 |     const res = await run(projectName, '--example', 'basic-css')
     |                 ^
  67 |     expect(res.exitCode).toBe(0)
  68 | 
  69 |     expect(

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at Object.<anonymous> (integration/create-next-app/index.test.js:66:17)

● create next app › should allow example with GitHub URL

Command failed with exit code 1 (EPERM): node /home/runner/work/next.js/next.js/packages/create-next-app/dist/index.js github-app --example https://github.com/zeit/next-learn-demo/tree/master/1-navigate-between-pages

  81 |   it('should allow example with GitHub URL', async () => {
  82 |     const projectName = 'github-app'
> 83 |     const res = await run(
     |                 ^
  84 |       projectName,
  85 |       '--example',
  86 |       'https://github.com/zeit/next-learn-demo/tree/master/1-navigate-between-pages'

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at Object.<anonymous> (integration/create-next-app/index.test.js:83:17)

● create next app › should allow example with GitHub URL and example-path

Command failed with exit code 1 (EPERM): node /home/runner/work/next.js/next.js/packages/create-next-app/dist/index.js github-example-path --example https://github.com/zeit/next-learn-demo/tree/master --example-path 1-navigate-between-pages

  104 |   it('should allow example with GitHub URL and example-path', async () => {
  105 |     const projectName = 'github-example-path'
> 106 |     const res = await run(
      |                 ^
  107 |       projectName,
  108 |       '--example',
  109 |       'https://github.com/zeit/next-learn-demo/tree/master',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at Object.<anonymous> (integration/create-next-app/index.test.js:106:17)

● create next app › should use --example-path over the file path in the GitHub URL

Command failed with exit code 1 (EPERM): node /home/runner/work/next.js/next.js/packages/create-next-app/dist/index.js github-example-path-2 --example https://github.com/zeit/next-learn-demo/tree/master/1-navigate-between-pages --example-path 1-navigate-between-pages

  129 |   it('should use --example-path over the file path in the GitHub URL', async () => {
  130 |     const projectName = 'github-example-path-2'
> 131 |     const res = await run(
      |                 ^
  132 |       projectName,
  133 |       '--example',
  134 |       'https://github.com/zeit/next-learn-demo/tree/master/1-navigate-between-pages',

  at makeError (../node_modules/execa/lib/error.js:58:11)
  at handlePromise (../node_modules/execa/index.js:112:26)
  at Object.<anonymous> (integration/create-next-app/index.test.js:131:17)

ijjk · 2020-03-23T20:32:03Z

Stats from current PR

Default Server Mode

General

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
buildDuration	10.2s	10s	-188ms
nodeModulesSize	52.8 MB	52.8 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
main-HASH.js gzip	6.24 kB	6.24 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
de003c3a9d30..c6c1.js gzip	10.1 kB	10.1 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	56.2 kB	56.2 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
main-HASH.module.js gzip	4.78 kB	4.78 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
de003c3a9d30..dule.js gzip	6.71 kB	6.71 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	51.4 kB	51.4 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
polyfills-HASH.js gzip	26.3 kB	26.3 kB	✓
Overall change	26.3 kB	26.3 kB	✓

Client Pages

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
_app.js gzip	1.24 kB	1.24 kB	✓
_error.js gzip	3.15 kB	3.15 kB	✓
hooks.js gzip	664 B	664 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.03 kB	2.03 kB	✓
routerDirect.js gzip	279 B	279 B	✓
withRouter.js gzip	278 B	278 B	✓
Overall change	7.86 kB	7.86 kB	✓

Client Pages Modern

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
_app.module.js gzip	594 B	594 B	✓
_error.module.js gzip	2.08 kB	2.08 kB	✓
hooks.module.js gzip	370 B	370 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	1.48 kB	1.48 kB	✓
routerDirect..dule.js gzip	271 B	271 B	✓
withRouter.m..dule.js gzip	270 B	270 B	✓
Overall change	5.28 kB	5.28 kB	✓

Client Build Manifests

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Rendered Page Sizes

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
index.html gzip	919 B	919 B	✓
link.html gzip	927 B	927 B	✓
withRouter.html gzip	916 B	916 B	✓
Overall change	2.76 kB	2.76 kB	✓

Serverless Mode (Increase detected ⚠️)

General

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
buildDuration	10.5s	10.7s	⚠️ +231ms
nodeModulesSize	52.8 MB	52.8 MB	✓

Client Bundles (main, webpack, commons)

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
main-HASH.js gzip	6.24 kB	6.24 kB	✓
webpack-HASH.js gzip	746 B	746 B	✓
de003c3a9d30..c6c1.js gzip	10.1 kB	10.1 kB	✓
framework.HASH.js gzip	39.1 kB	39.1 kB	✓
Overall change	56.2 kB	56.2 kB	✓

Client Bundles (main, webpack, commons) Modern

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
main-HASH.module.js gzip	4.78 kB	4.78 kB	✓
webpack-HASH..dule.js gzip	746 B	746 B	✓
de003c3a9d30..dule.js gzip	6.71 kB	6.71 kB	✓
framework.HA..dule.js gzip	39.1 kB	39.1 kB	✓
Overall change	51.4 kB	51.4 kB	✓

Legacy Client Bundles (polyfills)

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
polyfills-HASH.js gzip	26.3 kB	26.3 kB	✓
Overall change	26.3 kB	26.3 kB	✓

Client Pages

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
_app.js gzip	1.24 kB	1.24 kB	✓
_error.js gzip	3.15 kB	3.15 kB	✓
hooks.js gzip	664 B	664 B	✓
index.js gzip	222 B	222 B	✓
link.js gzip	2.03 kB	2.03 kB	✓
routerDirect.js gzip	279 B	279 B	✓
withRouter.js gzip	278 B	278 B	✓
Overall change	7.86 kB	7.86 kB	✓

Client Pages Modern

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
_app.module.js gzip	594 B	594 B	✓
_error.module.js gzip	2.08 kB	2.08 kB	✓
hooks.module.js gzip	370 B	370 B	✓
index.module.js gzip	212 B	212 B	✓
link.module.js gzip	1.48 kB	1.48 kB	✓
routerDirect..dule.js gzip	271 B	271 B	✓
withRouter.m..dule.js gzip	270 B	270 B	✓
Overall change	5.28 kB	5.28 kB	✓

Client Build Manifests

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
_buildManifest.js gzip	61 B	61 B	✓
_buildManife..dule.js gzip	61 B	61 B	✓
Overall change	122 B	122 B	✓

Serverless bundles Overall increase ⚠️

	zeit/next.js canary	lfades/next.js docs/update-gip	Change
_error.js gzip	293 kB	293 kB	-83 B
404.html gzip	1.32 kB	1.32 kB	✓
hooks.html gzip	960 B	960 B	✓
index.js gzip	293 kB	294 kB	⚠️ +763 B
link.js gzip	301 kB	301 kB	-8 B
routerDirect.js gzip	300 kB	300 kB	⚠️ +201 B
withRouter.js gzip	300 kB	300 kB	⚠️ +12 B
Overall change	1.49 MB	1.49 MB	⚠️ +885 B

Updated docs

b581d6e

lfades requested review from chibicode and timneutkens March 23, 2020 20:25

lfades requested a review from Timer as a code owner March 23, 2020 20:25

chibicode approved these changes Mar 23, 2020

View reviewed changes

Timer approved these changes Mar 23, 2020

View reviewed changes

Timer added Documentation labels Mar 23, 2020

Timer added this to the 9.3.2 milestone Mar 23, 2020

ijjk approved these changes Mar 23, 2020

View reviewed changes

ijjk and others added 9 commits March 23, 2020 17:37

bump

529bf90

Merge branch 'canary' into docs/update-gip

c891cf1

Merge branch 'canary' into docs/update-gip

5627cd6

Merge branch 'canary' into docs/update-gip

43581cc

Merge branch 'canary' into docs/update-gip

7559193

Merge branch 'canary' into docs/update-gip

c5b5cc3

Merge branch 'canary' into docs/update-gip

f11aab0

Merge branch 'canary' into docs/update-gip

6bd0993

Merge branch 'canary' into docs/update-gip

cb2c9d2

ijjk merged commit 1690a75 into vercel:canary Mar 23, 2020

This was referenced Apr 13, 2020

[Snyk] Upgrade next from 9.3.2 to 9.3.4 yowainwright/Advanced-React#46

Merged

[Snyk] Upgrade next from 9.3.1 to 9.3.2 cds-snc/next-holidays#35

Closed

This was referenced Apr 22, 2020

[Snyk] Upgrade next from 9.3.2 to 9.3.3 zagrajmy/frontend#162

Merged

[Snyk] Upgrade next from 9.3.2 to 9.3.3 grouparoo/next-plugins-example#9

Closed

[Snyk] Upgrade next from 9.3.2 to 9.3.3 GreyWolfLab/devPortal#3

Open

vercel locked as resolved and limited conversation to collaborators Jan 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update GIP docs #11303

Update GIP docs #11303

lfades commented Mar 23, 2020

ijjk commented Mar 23, 2020

ijjk commented Mar 23, 2020

Update GIP docs #11303

Update GIP docs #11303

Conversation

lfades commented Mar 23, 2020

ijjk commented Mar 23, 2020

Failing test suites

ijjk commented Mar 23, 2020

Stats from current PR