Skip to content

Commit

Permalink
Added a changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
patricklafrance committed Nov 16, 2018
1 parent 8236b3a commit 9346d67
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Expand Up @@ -12,6 +12,10 @@ All you have to do is create your app using [create-react-app](https://github.co
- [Recipes](https://github.com/sharegate/craco/tree/master/recipes) – Short recipes for common use cases.
- [Develop a Plugin](https://github.com/sharegate/craco/blob/master/packages/craco/README.md#develop-a-plugin) - How to develop a plugin for `craco`.

## Changelog

Major changes are available in the [changelog folder](https://github.com/sharegate/craco/tree/master/changelog).

## Community Maintained Plugins

* [craco-preact](https://github.com/FormAPI/craco-preact) by [@FormAPI](https://github.com/FormAPI)
Expand Down
55 changes: 55 additions & 0 deletions changelog/3.0.0.md
@@ -0,0 +1,55 @@
# Breaking change in 3.0.0

If you were using the CLI option `--react-scripts` your `craco` setup will not work for 3.0.0.

Prior to 3.0.0, `--react-scripts` base path was `current_working_directory\node_modules`.

In 3.0.0, `--react-scripts` is now `current_working_directory`.

## The easy fix

Remove 1 level from the relative path you provide to `--react-scripts`.

Before:

```bash
$ craco start --react-scripts ../../../node_modules/react-scripts
```

After:

```bash
$ craco start --react-scripts ../../node_modules/react-scripts
```

## You use a fork of react-scripts

If you provided `--react-scripts` because you're using a fork of `CRA` like `react-scripts-ts`, you should use `--scripts-version` instead.

Before:

```bash
$ craco start --react-scripts react-scripts-ts
```

After:

```bash
$ craco start --scripts-version react-scripts-ts
```

## You use a monorepo

If you provided `--react-scripts` because you use **yarn workspace** or any other **monorepo setup** that follow the `packages/*` convention, you should use `--workspace` instead.

Before:

```bash
$ craco start --react-scripts ../../../node_modules/react-scripts
```

After:

```bash
$ craco start --workspace
```
7 changes: 7 additions & 0 deletions packages/craco/README.md
Expand Up @@ -11,6 +11,7 @@ All you have to do is create your app using [create-react-app](https://github.co
- [Recipes](https://github.com/sharegate/craco/tree/master/recipes) – Short recipes for common use cases.
- [Available Plugins](https://github.com/sharegate/craco#community-maintained-plugins) - Plugins maintained by the community.
- [Develop a Plugin](#develop-a-plugin) - How to develop a plugin for `craco`.
- [Changelog](https://github.com/sharegate/craco/tree/master/changelog) - List of major changes

**Acknowledgements:**

Expand All @@ -22,6 +23,12 @@ Also, please note that the configuration style of this plugin has been greatly i

By doing this you're breaking the ["guarantees"](https://github.com/facebookincubator/create-react-app/issues/99#issuecomment-234657710) that CRA provides. That is to say you now "own" the configs. **No support** will be provided. Proceed with caution.

## You updated craco and everything falls apart

Before logging an issue, please consult the [changelog](https://github.com/sharegate/craco/tree/master/changelog).

If you can't find any solution to your problem in the changelog, log an issue and someone should help you quickly!

## Installation

Install the plugin from **npm**:
Expand Down

0 comments on commit 9346d67

Please sign in to comment.