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

Docs: Clarify Netlify build and deployment and advise not to use the Netlify CLI #6261

Merged

Conversation

dthyresson
Copy link
Contributor

Fixes #6260

There has been some confusion in Discord where some people were trying to build and deploy a redwoodJS app to Netlofy using Netlify's CLI and the build and deploy commands.

These commands with build the RedwoodJS locally (using the local settings and local OS) and then deploy the dist.

Problems arise with some package locations and how the list in bundled ... but the biggest issue is that the Prisma client will build using Windows or OSX and Netlfiy deploys need a linux variant.

So, the Prisma client that gets deployed is incompatible and fails.

Therefore, documentation needs to advise against using the Netlify and use the approach already documented in:

Updates docs here: redwoodjs.com/docs/tutorial/chapter4/deployment#netlify and in the deploy and cli command.

Also, adds a note in the yarn rw setup deploy netlify command.

Note: I looked for a way to include markdown snippets since the copy is essentially the same and would be nicer to include the cautionary admonition to keep the copy consistent and easier to edit. I didn't see a way immediately, but would much rather do that if possible./

@dthyresson dthyresson added the release:chore This PR is a chore (means nothing for users) label Aug 22, 2022
@nx-cloud
Copy link

nx-cloud bot commented Aug 22, 2022

☁️ Nx Cloud Report

We didn't find any information for the current pull request with the commit f306266.
You might need to set the 'NX_BRANCH' environment variable in your CI pipeline.

Check the Nx Cloud Github Integration documentation for more information.


Sent with 💌 from NxCloud.

@netlify
Copy link

netlify bot commented Aug 22, 2022

Deploy Preview for redwoodjs-docs ready!

Name Link
🔨 Latest commit f306266
🔍 Latest deploy log https://app.netlify.com/sites/redwoodjs-docs/deploys/63075814408707000808bed0
😎 Deploy Preview https://deploy-preview-6261--redwoodjs-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Contributor

@ericapisani ericapisani left a comment

Choose a reason for hiding this comment

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

Some small typos but this is otherwise is looking good to me, thanks for making these changes!

docs/docs/cli-commands.md Outdated Show resolved Hide resolved
docs/docs/deploy/netlify.md Outdated Show resolved Hide resolved
docs/docs/tutorial/chapter4/deployment.md Outdated Show resolved Hide resolved
@dthyresson
Copy link
Contributor Author

@ericapisani Thanks. I am the king of typos.

Copy link
Member

@Tobbe Tobbe left a comment

Choose a reason for hiding this comment

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

I made some suggestions. But they're just that -- suggestions. Feel free to pick and choose and/or modify as you like.

If you do decide to make any changes those same changes needs to be made in the other files you updated too

docs/docs/cli-commands.md Outdated Show resolved Hide resolved
docs/docs/cli-commands.md Outdated Show resolved Hide resolved
docs/docs/cli-commands.md Outdated Show resolved Hide resolved
dthyresson and others added 3 commits August 22, 2022 14:42
docs/docs/deploy/netlify.md Outdated Show resolved Hide resolved
docs/docs/tutorial/chapter4/deployment.md Outdated Show resolved Hide resolved
@dthyresson dthyresson enabled auto-merge (squash) August 25, 2022 11:08
@dthyresson dthyresson merged commit 842eb71 into redwoodjs:main Aug 25, 2022
@redwoodjs-bot redwoodjs-bot bot added this to the next-release milestone Aug 25, 2022
dac09 added a commit to dac09/redwood that referenced this pull request Aug 25, 2022
…-performance

* 'main' of github.com:redwoodjs/redwood:
  Docs: Clarify Netlify build and  deployment and advise not to use the Netlify CLI (redwoodjs#6261)
  fix(deps): update dependency eslint-plugin-react to v7.31.0 (redwoodjs#6289)
  fix(deps): update graphql-tools monorepo (redwoodjs#6285)
  fix(deps): update graphqlcodegenerator monorepo (redwoodjs#6286)
  fix(deps): update dependency core-js to v3.25.0 (redwoodjs#6287)
  chore(deps): update dependency firebase to v9.9.3 (redwoodjs#6258)
  fix: `import/order` should treat "glob star" imports as their own group (redwoodjs#6213)
  install emotion react w/ mantine packages (redwoodjs#6257)
  feat(ts): Improve types for directives (redwoodjs#6272)
@jtoar jtoar modified the milestones: next-release, v3.0.0 Sep 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:chore This PR is a chore (means nothing for users)
Projects
Status: Done
4 participants