⚠️ BUG ALERT ⚠️ Some users are experiencing a bug involving the Router not loading generated Pages. We are working on a hotfix and at this time do not recommend upgrading to v0.8.0. You can follow along here for more information and updates.

v0.8.0 Highlights

• New Magic.Link Auth provider 🔐 (documentation) #562
• New Destroy command 💥 allows you to undo your rw generate fails. See all the options via yarn rw destroy --help. #487
• Jest Tests Mocks for Web (initial documentation) #521
• Upgrades Prisma to v2.0.0-beta.6 (release notes)

Thank You to everyone below who contributed to this release. Redwood is better because of you!

Changed

• Prisma: Upgrade to Prisma-2.0.0-beta.6 #619
• Cell: enable cell to take functions for a query #505 @eurobob
• Cell: allow non-cell files name end with Cell #554 @gfpacheco
• Tests: Improve testing capabilities for Web #521 @RobertBroersma
• Dev-Server: add IP address to the Lambda event's requestContext in dev server #553 @bjackson
• Dev-Server: refactor Dev Server #573
• CLI: updates CLI build option to set default based on existing Sides (API or Web) #576
• CLI: Improve building api by first checking if api/prisma/ exists #595
• Docs: add reference section to CONTRIBUTING.md #577 @jtoar
• Docs: add Private and Redirect to Router README #616 @twmilli
• Forms: allow override of input props #580 @gfpacheco
• Forms: update scaffold css to use semantic classes #611 @Terris

Added

• CLI: add destroy command #487 @antonmoiseev
• Auth: Magic.Link added as provider to @redwoodjs/auth #562 @Burnsy

Fixed

• CLI: fix db/generate (nested command-dirs) help messages #555 @jtoar
• Cell: Fix cell plugin not handling default and named export #601 @gfpacheco
• Dev-Server: Fix dev server run error when path contains spaces #609

Breaking ⚠️

No breaking changes. 🎉

How to upgrade RedwoodJS packages to v0.8

If the Current Version is > v0.6.0

Redwood v0.6.0 included a new CLI command to upgrade @redwoodjs NPM packages. Run the following command within your App directory:

yarn rw upgrade

If the Current Version is < v0.6.0

Manually update the following @redwoodjs/* packages.

Root directory package.json

• "@redwoodjs/core": "^0.8.0”

web/package.json

• "@redwoodjs/web": "^0.8.0”
• "@redwoodjs/router": "^0.8.0”
• "@redwoodjs/auth": "^0.8.0” (if installed)

api/package.json

• "@redwoodjs/api": "^0.8.0”

Install the upgraded packages

$ yarn install

This release introduces the new 🎉 Redwood Auth Package 🎉 , which is a lightweight wrapper around popular SPA authentication libraries. Current support includes Netlify Identity Widget, Auth0, and Netlify GoTrue-JS. (With more on the way!) And it wouldn't be done the Redwood Way if it didn't include a generator to handle the boilerplate for you. We hope you find it delightful to use!

Getting Started with Redwood Auth

Documentation

• Redwood Auth Guide has all the details
• Complete the new Redwood Tutorial Authentication section to add Auth to your RedwoodBlog

Example App Implementations

• Learn to implement Netlify Auth via the Redwood Example Blog tutorial
• Explore Auth implementation in the Example Invoice project

CLI Trailblazing

• Feeling 😜 ? Just dive in with yarn rw g auth [netlify|auth0]

Other v0.7.0 Highlights 🚀

• New Function generator and Custom Function Cookbook guide
• New Scaffold generator option to add 'path/' structure via yarn rw g scaffold <path/model> #423
• New Form fields (too many to list!) and improvements to Redwood Forms
• Upgrades Prisma to v2.0.0-beta.5 (release notes for beta.4 and beta.5)

And a gigantic Thank You to all the amazing contributors below who are making Redwood better every day. It's a blast to build this with you! 🙌

Changed

• Dev-server: improve Error Handling at FatalErrorBoundary #486
• Generators: humanize labels on scaffold forms #493 @lachlanjc
• Config: convert custom webpack cell-loader into Babel Plugin #512 @RobertBroersma
• Prisma: upgrade to Prisma v2.0.0-beta.5 #525 #532
  • ⚠️ possible breaking change to migration files; see "Breaking" below

Added

• Auth: add @redwoodjs/auth package #497 #536 🎉
• Generators: adds auth generator #539 🎉
• Generators: adds function generator #517 🎉
• Generators: add path specification to scaffolds #423 @jtoar 🎉
• CLI: add console log on rebuild complete #504 @vikash-eatgeek
• CLI: add @redwoodjs/auth package to CLI upgrade command #556
  • CLI upgrade command: add option --tag with choices 'canary' or 'rc' #560
• Docs: add router docs for useMatch and NavLink #470 @RobertBroersma
• Forms: add Radio Field #479 @vikash-eatgeek
• Forms: add checkbox field #488 @vikash-eatgeek
• Forms: adds all input type Field form helpers #511

Fixed

• CLI: fix yarn rw info not displaying redwoodjs packages on Windows #476
• Generators: remove excess closing braces from foreign key map on scaffold generator #482 @eurobob
• Generators: fixes possible null error in truncate #485 @kwyoung11
• Generators: switch out "Hammer" data source in tests #506 @lachlanjc
• Generators: fix NamesCell reload after deleting item #519 @cephalization
• Dev-server: 'yarn rw dev' now only starts the API and DB servers when the api folder is present #490 @ackinc
• Dev-server: fix Prisma Client error when running dev server w/out DB #524
• Router: Convert children into array to do array things #547

Breaking ⚠️

For previously deployed applications, it is possible the new Prisma migration files from beta.5 are incompatible with previous migrations. If you encounter a migration error on deployment, follow these steps after you backup your deployment DB:

1. Remove your local Prisma "migrations/" directory and files.
2. Create a new migration via yarn rw db save
3. Drop the "_Migrations" table on your deployment DB
4. If you are using the netlify-plugin-prisma-provider, make sure it is at v0.3.0

Rerun your deployment, which should complete successfully.

How to upgrade RedwoodJS packages to v0.7.0

If the Current Version is v0.6.0

Redwood v0.6.0 includes a new CLI command to upgrade @redwoodjs NPM packages. Run the following command within your App directory:

yarn rw upgrade

If the Current Version is < v0.6.0

Manually update the four @redwoodjs/* packages.

Root directory package.json

• "@redwoodjs/core": "^0.7.0”

web/package.json

• "@redwoodjs/web": "^0.7.0”
• "@redwoodjs/router": "^0.7.0”

api/package.json

• "@redwoodjs/api": "^0.7.0”

Install the upgraded packages

$ yarn install

Along with bug fixes, ENV var support, Router enhancements, and improved TypeScript support, this release introduces a new workflow with CLI tools for contributing to the RedwoodJS Framework. For more information, please read CONTRIBUTING.md 🤩

Changed

• Prisma: upgrade to Prisma-2.0.0-beta.3 #457
• Config: Only use redwood-eslint-plugin when in a redwood project #443
• Framework: build core packages and reference them correctly #456
• TypeScript: Let api-dev-server and webpack load .ts and .tsx files #438

Added

• CLI: Add workflow tools for local development #429 #442
  • split rwdev watch into copy and copy:watch #445 @jtoar
  • fix build:watch scripts and own add own resolve function #455
  • edit CONTRIBUTING.md #435 @jtoar
• Config: support ENV vars in webpack projects #430 @snormore
  • write tests and docs for environmental variables #444
• Router: add useMatch for crafting stateful links #416 @RobertBroersma
• TypeScript: Setup TS Project References #359 @mohsen1
• CLI: add 'yarn rw upgrade' helper to upgrade @redwoodjs packages #436

Fixed

• Router: fixes validatePath duplicate params & reject spaces in routes #420 @olance
• Deploy: add process.exit(1) to ensure Netlify build fails on error #447
• CLI: fixes mutation constant names in generated code #458
• Docs: fix link markup #459 @benmccann

Breaking ⚠️

Breaking changes only apply to Apps upgrading from previous versions.

Prisma-2.0.0-beta.3 has two major changes that may affect some applications upgrading from previous Redwood versions.

• Enums are now disallowed for SQLite
• Required 1-1 self relations are forbidden now

Release notes are available here.

How to upgrade RedwoodJS packages to v0.6.0

Redwood v0.6.0 includes a new CLI command to upgrade @redwoodjs NPM packages. However, you must first upgrade to v0.6.0 to use yarn rw upgrade

Update your @redwoodjs/* packages.

Four packages should be updated to v0.6.0

Root directory package.json

• "@redwoodjs/core": "^0.6.0”

web/package.json

• "@redwoodjs/web": "^0.6.0”
• "@redwoodjs/router": "^0.6.0”

api/package.json

• "@redwoodjs/api": "^0.6.0”

After updating and saving the files, install the packages from the root directory:
$ yarn install

This release includes Prisma-2.0.0-beta.2, which is a big update that has many improvements, bug fixes, and new features. 🚀 Prisma introduced a new relation syntax and support, which allows for complex relationships within `schema.prisma' models. RedwoodJS has improved its generators to support many model relations' use-cases. However, there are generator support limitations, which you can read about here on our community Forum. 👈

Additionally, Redwood now has a Netlify Plugin to set the DB provider during deployment. See the section below "Using the New Netlify Provider Plugin" for more information.

Changed

• 🎉 Update Prisma to 2.0.0-Beta.2 (see release notes for Beta.2 and Beta.1)
  • change Prisma CLI command usage to prisma from prisma2
  • introduces new relation syntax and support for @relation. See the documentation here.
• Improve create-redwood-app release fetching #397 @satyarohith
• Misc documentation improvements #396 #406 #393 #422 @jtoar @petukhov @nhristov @cball
• Use URLSearchParams for parsing search params #357 @mohsen1
• Update GraphQL SDL "Required Types" logic #432

Added

• Netlify plugin to handle 'provider' as an env var during Netlify build. See CRA release v0.4.0-plugin
• CLI generator tests #401
• Export useApolloClient for one-off queries #413 @RobertBroersma
• CLI command yarn rw db introspect #385 @Jaikant
• Support table relationships in service generators #412

Fixed

• Router rendering bug #380
• Windows support for redwoodjs/redwood build scripts #363
• Windows support for create-redwood-app build scripts #410
• Redwood Router: fix route matching by enforcing type constraints #353 @olance
• Redwood Forms: fix setState warning from setError call #411 @dominicchapman

Breaking ⚠️

This breaking change only applies to Apps upgrading from previous versions.

Migration files from previous Prisma versions are incompatible with prisma-2.0.0-beta.2. This means new local and deploy migrations will likely fail for Apps upgrading. Workaround:

1. Remove the migration directory and files (delete api/prisma/migrations directory) and then re-create using yarn rw db save
2. If that doesn't resolve the issue, then delete the contents of the deployed DB _Migration table (if applicable)

Using the New Netlify Provider Plugin (optional)

These steps only apply to Apps upgrading from previous versions. New Apps already include these changes.

Redwood apps running any version can use the Netlify Provider plugin, which eliminates workarounds required to use ’SQLite’ for local development and ‘PostgreSQL’ (or other DBs) for production deployment.

If you are using PostgreSQL in production, follow the steps below.

If you need to customize your DB provider (to use MySQL, for example), refer to documentation for 'netlify-plugin-prisma-provider’. Changing the provider is as simple as adding a new environment variable in Netlify.

Add the plugin package to your App

Redwood uses yarn workspaces. Run this command to add the package to the root package.json.
yarn add -W netlify-plugin-prisma-provider

Update Netlify deployment settings

Add the following configuration to your App’s netlify.toml:

[[plugins]]
package = 'netlify-plugin-prisma-provider'
  [plugins.inputs]
  path = 'api/prisma/schema.prisma'

How to upgrade RedwoodJS packages to v0.5.0

Update your @redwoodjs/* packages.

Four packages should be updated to v0.5.0

Root directory package.json

• "@redwoodjs/core": "^0.5.0”

web/package.json

• "@redwoodjs/web": "^0.5.0”
• "@redwoodjs/router": "^0.5.0”

api/package.json

• "@redwoodjs/api": "^0.5.0”

After updating and saving the files, install the packages from the root directory:
$ yarn install

Changed

• Upgraded Prisma2 to preview025 #350
  • ⚠️ Prisma introduced a new relation syntax, which is not compatible with previous migration files. If you have a deployed app and need to migrate DB changes, see this Issue providing a workaround.
• Context handlers accept an asynchronous function #348 @RobertBroersma
• Upgrade package dependencies including Babel 7.9, React Hook Form v5, and Prettier v2 #349
• Forward refs to anchors in Links #356 @RobertBroersma

Added

• Support for graphql directives! #347 @RobertBroersma
• Format generated templates using the local prettier.config.js #351 @satyarohith
• Docs for webpack config #354 @maximgeerinck

Fixed

• Fixed a problem with the Router where it would try to render a Page without the correct params. #380

How to upgrade to v0.4.0*

Update your @redwoodjs/* packages.

Four packages should be updated to v0.4.0

Root directory package.json

• "@redwoodjs/core": "^0.4.0”

web/package.json

• "@redwoodjs/web": "^0.4.0”
• "@redwoodjs/router": "^0.4.0”

api/package.json

• "@redwoodjs/api": "^0.4.0”

After updating and saving the files, install the packages from the root directory:
$ yarn install

⚠️ This release includes a breaking change where we no longer import db automatically (#334). See "How to upgrade to v0.3.2" for more information. ⚠️

Changed

• Do not import db automatically. #334

Added

• new command yarn rw info to get system environment #329
• create redwood-app can be instantiated in an empty directory #315 @olance
• Prisma is updated to preview24 #303
• Added a way to change the webpack configuration #312 @Idered

Fixed

• Fix Netlify deploy issue with src path #338
• Fix scaffold and sdl generator `Routes.js’ insertion order #336
• Fix yarn rw test #290
• Change the way that routes are matched so that it works in Firefox #308
• Fix ‘yarn rw help’ issue with output on Windows #331

👉 How to upgrade to v0.3.2

(1 of 3) Create a new folder and file api/src/lib/db.js

This adds a way to instantiate the database.

• create api/src/lib/db.js file
• copy and paste the following into db.js

// See https://github.com/prisma/prisma2/blob/master/docs/prisma-client-js/api.md#constructor
// for options.

import { PrismaClient } from '@prisma/client'

export const db = new PrismaClient()

(2 of 3) Add the db import to each of your Services files

For each Services file within api/src/services/*, do the following:

• add this line at the top:

// api/src/services/*
import { db } from 'src/lib/db'

Add the import to your api/src/functions/graphql.js file

// api/src/functions/graphql.js
import { db } from 'src/lib/db'

For example, if you completed the RedwoodJS Tutorial you would have posts.js and contacts.js within api/src/services/posts/ and api/src/services/contacts/, respectively. You would add the import statement to the top of each of those files.

(3 of 3) Update your @redwoodjs/* packages.

Four packages should be updated to v0.3.2

Root directory package.json

• "@redwoodjs/core": "^0.3.2”

web/package.json

• "@redwoodjs/web": "^0.3.2”
• "@redwoodjs/router": "^0.3.2”

api/package.json

• "@redwoodjs/api": "^0.3.2”

After updating and saving the files, install the packages from the root directory:
$ yarn install

⚠️ This release includes a breaking change where we no longer import db automatically (#334). See "How to upgrade to v0.3.0" for more information. ⚠️

Changed

• Do not import db automatically. #334

Added

• new command yarn rw info to get system environment #329
• create redwood-app can be instantiated in an empty directory #315 @olance
• Prisma is updated to preview24 #303
• Added a way to change the webpack configuration #312 @Idered

Fixed

• Fix yarn rw test #290
• Change the way that routes are matched so that it works in Firefox #308
• Fix ‘yarn rw help’ issue with output on Windows #331

👉 How to upgrade to v0.3.0

(1 of 3) Create a new folder and file api/src/lib/db.js

This adds a way to instantiate the database.

• create api/src/lib/db.js file
• copy and paste the following into db.js

// See https://github.com/prisma/prisma2/blob/master/docs/prisma-client-js/api.md#constructor
// for options.

import { PrismaClient } from '@prisma/client'

export const db = new PrismaClient()

(2 of 3) Add the db import to each of your Services files

For each Services file within api/src/services/*, do the following:

• add this line at the top:

import { db } from 'src/lib/db'

For example, if you completed the RedwoodJS Tutorial you would have posts.js and contacts.js within api/src/services/posts/ and api/src/services/contacts/, respectively. You would add the import statement to the top of each of those files.

(3 of 3) Update your @redwoodjs/* packages.

Four packages should be updated to v0.3.0

Root directory package.json

• "@redwoodjs/core": "^0.3.0”

web/package.json

• "@redwoodjs/web": "^0.3.0”
• "@redwoodjs/router": "^0.3.0”

api/package.json

• "@redwoodjs/api": "^0.3.0”

After updating and saving the files, install the packages from the root directory:
$ yarn install

Fixed

• Create-Redwood-App move ‘binaryTarge’ from schema.prisma to env var redwoodjs/create-redwood-app/pull/39
• skip scaffold.css if it already exists 325433c
• Set fetchPolicy to cache-and-network for scaffolded list page #281

Items below include changes from v0.2.3 and v0.2.4

• Windows fix Cell regex issue #276
• Pass resolver info object to services e842179
• misc bug fixes and repo-specific CI improvements to tests and linter #247 #257 #262 #274
• return RWJS version in GraphQL query #255 | kudos @AryanJ-NYC
• improve README with links and fixes #266 | kudos @Thieffen
• security warning fix #274

How to Upgrade your RedwoodJS App

File Changes

You will need to replicate changes to three files shown in redwoodjs/create-redwood-app/#39

1. .env
2. .env.defaults
3. api/prisma/schema.prisma

Package Updates

Four packages should be updated to v0.2.5

Root directory package.json

• "@redwoodjs/core": "^0.2.5”
  web/package.json
• "@redwoodjs/web": "^0.2.5”
• "@redwoodjs/router": "^0.2.5”
  api/package.json
• "@redwoodjs/api": "^0.2.5”

After updating and saving the files, install the packages from the root directory:
$ yarn install

Fixed

• Fix order of routes #211 @gielcobben
• Update submit button to accept references #230 @leonardoelias
• Do not duplicate routes #241 @sharcastic
• Automatic imports for page are now fixed in windows. #246

How to Upgrade your RedwoodJS App

Four packages should be updated to v0.2.2:

Root directory package.json

• "@redwoodjs/core": "^0.2.2”
  web/package.json
• "@redwoodjs/web": "^0.2.2”
• "@redwoodjs/router": "^0.2.2”
  api/package.json
• "@redwoodjs/api": "^0.2.2”

Once you’ve changed and saved the files, run yarn install from root directory.

Added

• We now automatically map exports from services to your schema definitions. #87 @peterp
• We added a bunch of functionality to the redwood cli. #91

Changed

• Upgraded to Prisma 21 #92

Added

• A splash page that's shown when you don't have any routes. #17 @mojombo
• Router parameter types. #47 @mojombo
• Added forms to web #45 @cannikin
• Alias redwood CLI command to rw #79 @sw-yx
• FatalErrorBoundary #61 @mojombo
• Use the Empty branch the data returned from a cell is empty. #54 @cannikin
• Added a way to create a new Redwood project using yarn create redwood-app path/to/project #60 @peterp
• An import all marco that runs at build time. #86 @peterp

Changed

• We're having some trouble with favicons-webpack-plugin. So we've removed it. #37 @cannikin
• Automatically adds the withCell code at build time in Webpack. #48 @mojombo

Fixed

• Webpack hot module reloading #43 @peterp
• beforeQuery automatically maps the props in a cell to the variables in a query #50 @cannikin

In this release we continue towards making the steps in our tutorial a reality.

Added

• A webpack plugin that automatically imports components from web/src/pages/* into Routes.js and an accompanying ESLint plugin that'll let you know when you're referencing a page that doesn't exist. #21 @mojombo
• getPaths into @redwoodjs/core that gives Redwood packages a single and stable place to references paths in a Redwood project. #24 @peterp

This is the first release of hammer and it doesn't actually do anything useful 🎉

I've added the hammer-cli that allows anyone to add new commands in the the src/commands directory. Right now we only have a single generate command with a single component generator. The component generator plops a ⚒ hammer style component into the web/src/components folder of your hammer project.