Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(package.json): add contributor-friendly lifecycle scripts #27825

Merged
merged 3 commits into from
Aug 9, 2021

Conversation

ctjlewis
Copy link
Contributor

@ctjlewis ctjlewis commented Aug 6, 2021

Feature

I was struggling to get my local dev build working as a local package.json override, and types do not seem to be generated by yarn dev, so I had to figure out a cohesive way to build the project start-to-finish (and also clean the project).

Building the project and all types ended up just being yarn prepublish, here aliased as yarn build, and I added a yarn clean script. These two together should make it very difficult for any contributor to be confused how to generate a final build including all type declarations.

  • Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
  • Related issues linked using fixes #number
  • Integration tests added
  • Documentation added
  • Telemetry added. In case of a feature if it's used or not.
  • Errors have helpful link attached, see contributing.md

Documentation / Examples

https://github.com/ctjlewis/next.js/blob/b2a888c14405d7978dc612fc4c66db208038736f/contributing.md#building

@ctjlewis ctjlewis changed the title Contributor friendly scripts feat(package.json): add contributor-friendly scripts Aug 6, 2021
@ctjlewis ctjlewis changed the title feat(package.json): add contributor-friendly scripts feat(package.json): add contributor-friendly lifecycle scripts Aug 6, 2021
@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Aug 9, 2021

Stats from current PR

Default Build (Decrease detected ✓)
General
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
buildDuration 12.6s 12.7s ⚠️ +102ms
buildDurationCached 2.9s 3s ⚠️ +16ms
nodeModulesSize 50.2 MB 50.2 MB
Page Load Tests Overall decrease ⚠️
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
/ failed reqs 0 0
/ total time (seconds) 2.286 2.293 ⚠️ +0.01
/ avg req/sec 1093.48 1090.15 ⚠️ -3.33
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.288 1.29 0
/error-in-render avg req/sec 1940.47 1938.25 ⚠️ -2.22
Client Bundles (main, webpack, commons)
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
745.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.2 kB 42.2 kB
main-HASH.js gzip 23.1 kB 23.1 kB
webpack-HASH.js gzip 1.5 kB 1.5 kB
Overall change 67 kB 67 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
polyfills-HASH.js gzip 31.1 kB 31.1 kB
Overall change 31.1 kB 31.1 kB
Client Pages
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
_app-HASH.js gzip 980 B 980 B
_error-HASH.js gzip 194 B 194 B
amp-HASH.js gzip 312 B 312 B
css-HASH.js gzip 329 B 329 B
dynamic-HASH.js gzip 2.52 kB 2.52 kB
head-HASH.js gzip 350 B 350 B
hooks-HASH.js gzip 904 B 904 B
image-HASH.js gzip 4.12 kB 4.12 kB
index-HASH.js gzip 261 B 261 B
link-HASH.js gzip 1.66 kB 1.66 kB
routerDirect..HASH.js gzip 319 B 319 B
script-HASH.js gzip 387 B 387 B
withRouter-HASH.js gzip 320 B 320 B
bb14e60e810b..30f.css gzip 125 B 125 B
Overall change 12.8 kB 12.8 kB
Client Build Manifests
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
_buildManifest.js gzip 490 B 490 B
Overall change 490 B 490 B
Rendered Page Sizes
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
index.html gzip 531 B 531 B
link.html gzip 543 B 543 B
withRouter.html gzip 524 B 524 B
Overall change 1.6 kB 1.6 kB

Webpack 4 Mode (Increase detected ⚠️)
General
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
buildDuration 10.5s 10.5s ⚠️ +12ms
buildDurationCached 4.1s 4.1s -66ms
nodeModulesSize 50.2 MB 50.2 MB
Page Load Tests Overall increase ✓
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
/ failed reqs 0 0
/ total time (seconds) 2.324 2.298 -0.03
/ avg req/sec 1075.64 1087.93 +12.29
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.29 1.275 -0.02
/error-in-render avg req/sec 1937.85 1960.06 +22.21
Client Bundles (main, webpack, commons)
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
17.HASH.js gzip 185 B 185 B
677f882d2ed8..HASH.js gzip 14 kB 14 kB
framework.HASH.js gzip 41.9 kB 41.9 kB
main-HASH.js gzip 10.6 kB 10.6 kB
webpack-HASH.js gzip 1.19 kB 1.19 kB
Overall change 67.8 kB 67.8 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
polyfills-HASH.js gzip 31.3 kB 31.3 kB
Overall change 31.3 kB 31.3 kB
Client Pages
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
_app-HASH.js gzip 965 B 965 B
_error-HASH.js gzip 3.71 kB 3.71 kB
amp-HASH.js gzip 552 B 552 B
css-HASH.js gzip 333 B 333 B
dynamic-HASH.js gzip 2.71 kB 2.71 kB
head-HASH.js gzip 2.97 kB 2.97 kB
hooks-HASH.js gzip 911 B 911 B
index-HASH.js gzip 231 B 231 B
link-HASH.js gzip 1.64 kB 1.64 kB
routerDirect..HASH.js gzip 298 B 298 B
script-HASH.js gzip 2.94 kB 2.94 kB
withRouter-HASH.js gzip 294 B 294 B
e025d2764813..52f.css gzip 125 B 125 B
Overall change 17.7 kB 17.7 kB
Client Build Manifests
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
_buildManifest.js gzip 498 B 498 B
Overall change 498 B 498 B
Rendered Page Sizes
vercel/next.js canary ctjlewis/next.js contributor-friendly-scripts Change
index.html gzip 577 B 577 B
link.html gzip 589 B 589 B
withRouter.html gzip 571 B 571 B
Overall change 1.74 kB 1.74 kB
Commit: c11e60a

@kodiakhq kodiakhq bot merged commit c9ff4c7 into vercel:canary Aug 9, 2021
flybayer pushed a commit to blitz-js/next.js that referenced this pull request Aug 19, 2021
…l#27825)

## Feature

I was struggling to get my local dev build working as a local package.json override, and types do not seem to be generated by `yarn dev`, so I had to figure out a cohesive way to build the project start-to-finish (and also clean the project).

Building the project and all types ended up just being `yarn prepublish`, here aliased as `yarn build`, and I added a `yarn clean` script. These two together should make it very difficult for any contributor to be confused how to generate a final build including all type declarations.

- [ ] Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [x] Documentation added
- [ ] Telemetry added. In case of a feature if it's used or not.
- [ ] Errors have helpful link attached, see `contributing.md`

## Documentation / Examples

https://github.com/ctjlewis/next.js/blob/b2a888c14405d7978dc612fc4c66db208038736f/contributing.md#building
@vercel vercel locked as resolved and limited conversation to collaborators Jan 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants