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

Fixes #33153: Updating cross-references from master to main + canary #33198

Merged
merged 7 commits into from Jan 12, 2022

Conversation

mannybecerra
Copy link
Contributor

@mannybecerra mannybecerra commented Jan 11, 2022

Under #33153, the master branch was renamed to main. This PR updates existing cross references to the old master branch, specifically, to reference the canary branch (as the repo's default branch); in addition, a couple of relevant config-esque files were updated accordingly, e.g. lerna.json and azure...json

Questions:

Bug

  • Related issues linked using fixes #number
  • Integration tests added
  • Errors have helpful link attached, see contributing.md

Feature

  • 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

  • Make sure the linting passes by running yarn lint

@ijjk ijjk added create-next-app Related to our CLI tool for quickly starting a new Next.js application. area: documentation examples Issue/PR related to examples labels Jan 11, 2022
Copy link
Member

@ijjk ijjk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. Should these updated links actually point to canary instead of main or are the proposed changes to main fine?

I think it would be good to point to canary yeah as main isn't as up to date and not used now.

  1. Do these files need to be updated to reflect this branch name change?
    https://github.com/vercel/next.js/blob/canary/lerna.json
    https://github.com/vercel/next.js/blob/fdb2cc80b1a0c5a610f484874aba33e0ff6db496/azure-pipelines.yml

For the lerna.json file it looks like we can remove master from that array as we don't publish from any other branch than canary. For azure-pipelines it does look like we want to update that exclude for master to main now.

@ijjk

This comment has been minimized.

mannybecerra and others added 3 commits January 11, 2022 13:49
…ter` branch to renamed default branch of `main`
…nnyb/docs

# Conflicts:
#	docs/api-reference/create-next-app.md
#	examples/analyze-bundles/README.md
#	examples/progressive-web-app/pages/index.js
#	examples/with-apollo-and-redux/README.md
#	examples/with-cypress/pages/index.js
#	examples/with-docker/pages/index.js
#	examples/with-elasticsearch/pages/index.js
#	examples/with-jest-babel/__tests__/__snapshots__/snapshot.tsx.snap
#	examples/with-jest-babel/pages/index.tsx
#	examples/with-jest/__tests__/__snapshots__/snapshot.tsx.snap
#	examples/with-jest/pages/index.tsx
#	examples/with-knex/pages/index.js
#	examples/with-mdbreact/pages/index.js
#	examples/with-mongodb/pages/index.js
#	examples/with-playwright/pages/index.js
#	examples/with-rbx-bulma-pro/pages/index.js
#	examples/with-react-bootstrap/pages/index.jsx
#	examples/with-react-with-styles/README.md
#	examples/with-reactstrap/pages/index.jsx
#	examples/with-redux-persist/README.md
#	examples/with-redux-saga/README.md
#	examples/with-rematch/README.md
#	examples/with-sitemap/pages/index.js
#	examples/with-styled-jsx-postcss/README.md
#	examples/with-supertokens/pages/index.js
#	examples/with-tailwindcss/pages/index.tsx
#	examples/with-typestyle/README.md
#	packages/create-next-app/README.md
#	packages/create-next-app/templates/default/pages/index.js
#	packages/create-next-app/templates/typescript/pages/index.tsx
#	test/development/basic/tailwind-jit/pages/index.js
@mannybecerra
Copy link
Contributor Author

mannybecerra commented Jan 11, 2022

  1. Should these updated links actually point to canary instead of main or are the proposed changes to main fine?

I think it would be good to point to canary yeah as main isn't as up to date and not used now.

  1. Do these files need to be updated to reflect this branch name change?
    https://github.com/vercel/next.js/blob/canary/lerna.json
    https://github.com/vercel/next.js/blob/fdb2cc80b1a0c5a610f484874aba33e0ff6db496/azure-pipelines.yml

For the lerna.json file it looks like we can remove master from that array as we don't publish from any other branch than canary. For azure-pipelines it does look like we want to update that exclude for master to main now.

Great, thanks for confirming about lerna.json and azure-pipelines @ijjk - updated my PR accordingly, including referencing canary in lieu of main for the example cross-links. Any other desired changes, just give the word.

@ijjk
Copy link
Member

ijjk commented Jan 11, 2022

Stats from current PR

Default Build (Decrease detected ✓)
General Overall decrease ✓
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
buildDuration 13.9s 13.9s -2ms
buildDurationCached 3.1s 3.2s ⚠️ +28ms
nodeModulesSize 355 MB 355 MB -6 B
Page Load Tests Overall decrease ⚠️
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
/ failed reqs 0 0
/ total time (seconds) 2.817 2.843 ⚠️ +0.03
/ avg req/sec 887.36 879.48 ⚠️ -7.88
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.265 1.29 ⚠️ +0.03
/error-in-render avg req/sec 1976.61 1937.48 ⚠️ -39.13
Client Bundles (main, webpack, commons)
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
450.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.2 kB 42.2 kB
main-HASH.js gzip 27.2 kB 27.2 kB
webpack-HASH.js gzip 1.45 kB 1.45 kB
Overall change 71 kB 71 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
_app-HASH.js gzip 1.37 kB 1.37 kB
_error-HASH.js gzip 194 B 194 B
amp-HASH.js gzip 312 B 312 B
css-HASH.js gzip 326 B 326 B
dynamic-HASH.js gzip 2.37 kB 2.37 kB
head-HASH.js gzip 350 B 350 B
hooks-HASH.js gzip 919 B 919 B
image-HASH.js gzip 4.74 kB 4.74 kB
index-HASH.js gzip 263 B 263 B
link-HASH.js gzip 2.13 kB 2.13 kB
routerDirect..HASH.js gzip 321 B 321 B
script-HASH.js gzip 383 B 383 B
withRouter-HASH.js gzip 318 B 318 B
85e02e95b279..7e3.css gzip 107 B 107 B
Overall change 14.1 kB 14.1 kB
Client Build Manifests
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
_buildManifest.js gzip 459 B 459 B
Overall change 459 B 459 B
Rendered Page Sizes
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
index.html gzip 532 B 532 B
link.html gzip 546 B 546 B
withRouter.html gzip 527 B 527 B
Overall change 1.6 kB 1.6 kB

Default Build with SWC (Decrease detected ✓)
General Overall decrease ✓
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
buildDuration 15.5s 15.7s ⚠️ +201ms
buildDurationCached 3.2s 3.1s -21ms
nodeModulesSize 355 MB 355 MB -6 B
Page Load Tests Overall decrease ⚠️
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
/ failed reqs 0 0
/ total time (seconds) 2.846 2.901 ⚠️ +0.05
/ avg req/sec 878.48 861.74 ⚠️ -16.74
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.294 1.31 ⚠️ +0.02
/error-in-render avg req/sec 1932.27 1908.64 ⚠️ -23.63
Client Bundles (main, webpack, commons)
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
450.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.3 kB 42.3 kB
main-HASH.js gzip 27.3 kB 27.3 kB
webpack-HASH.js gzip 1.44 kB 1.44 kB
Overall change 71.2 kB 71.2 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
polyfills-HASH.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
_app-HASH.js gzip 1.35 kB 1.35 kB
_error-HASH.js gzip 180 B 180 B
amp-HASH.js gzip 305 B 305 B
css-HASH.js gzip 321 B 321 B
dynamic-HASH.js gzip 2.36 kB 2.36 kB
head-HASH.js gzip 342 B 342 B
hooks-HASH.js gzip 906 B 906 B
image-HASH.js gzip 4.76 kB 4.76 kB
index-HASH.js gzip 256 B 256 B
link-HASH.js gzip 2.19 kB 2.19 kB
routerDirect..HASH.js gzip 314 B 314 B
script-HASH.js gzip 375 B 375 B
withRouter-HASH.js gzip 309 B 309 B
85e02e95b279..7e3.css gzip 107 B 107 B
Overall change 14.1 kB 14.1 kB
Client Build Manifests
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
_buildManifest.js gzip 458 B 458 B
Overall change 458 B 458 B
Rendered Page Sizes
vercel/next.js canary mannybecerra/next.js mannyb/docs Change
index.html gzip 533 B 533 B
link.html gzip 545 B 545 B
withRouter.html gzip 527 B 527 B
Overall change 1.6 kB 1.6 kB
Commit: 9f94dfe

Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks!

@styfle styfle requested a review from ijjk January 12, 2022 01:10
@mannybecerra mannybecerra changed the title Fixes #33153: Updating cross-references from master to main Fixes #33153: Updating cross-references from master to main + canary Jan 12, 2022
@balazsorban44 balazsorban44 merged commit 36eba95 into vercel:canary Jan 12, 2022
teleaziz added a commit to teleaziz/next.js that referenced this pull request Jan 12, 2022
…o-example

* 'canary' of github.com:vercel/next.js:
  Added links to data fetching api refs, fixed title (vercel#33221)
  Removed backticks on data fetching api titles (vercel#33216)
  middlewares: limit `process.env` to inferred usage (vercel#33186)
  Fixed broken link (vercel#33209)
  v12.0.8
  v12.0.8-canary.22
  Refactor data fetching API docs (vercel#30615)
  Docs: correct ignorance pattern for .env.local (vercel#32647)
  Fixes vercel#33153: Updating cross-references from master to main + canary (vercel#33198)
  v12.0.8-canary.21
  Add util for normalizing errors (vercel#33159)
  Fix broken yarn pnp (vercel#32867)
@hsynlms hsynlms mentioned this pull request Jan 14, 2022
10 tasks
kodiakhq bot pushed a commit that referenced this pull request Jan 14, 2022
contributing.md file still refers `master` branch name since the branch renamed as `main` recently. This PR contains a fix for that.

**related:**
#33153
#33198

## Bug

- [ ] Related issues linked using `fixes #number`
- [ ] Integration tests added
- [ ] Errors have helpful link attached, see `contributing.md`

## Feature

- [ ] 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

- [x] Make sure the linting passes by running `yarn lint`


Co-authored-by: Tim Neutkens <6324199+timneutkens@users.noreply.github.com>
@vercel vercel locked as resolved and limited conversation to collaborators Feb 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
create-next-app Related to our CLI tool for quickly starting a new Next.js application. examples Issue/PR related to examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants