You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 31, 2024. It is now read-only.
* 'master' of https://github.com/facebook/create-react-app: (220 commits)
Publish
Changelog for 1.1.4
Update detect-port-alt (facebook#4250)
Publish
Changelog for 1.1.3
Work around Jest environment resolving bug (facebook#4247)
Publish
Add 1.1.2 changelog (facebook#4242)
Add troubleshooting for Github Pages (facebook#4197)
`.mjs` should not resolve before .js files (facebook#4085)
Publish
Revert "Set the public path to the asset manifest entries (facebook#2544)"
Add 1.1.1 changelog
Unpin and bump fsevents (for 1.x branch) (facebook#4006)
Update dotenv-expand to fix bug with environment variables that contain a $. (facebook#4000)
Update instructions for continuous delivery with Netlify (facebook#3971)
Include `{json,css}` files in prettier command (facebook#3894)
Set the public path to the asset manifest entries (facebook#2544)
1.5.1
pin envinfo version to 3.4.2 (facebook#3853)
...
# Conflicts:
# packages/react-scripts/config/webpack.config.prod.js
# packages/react-scripts/package.json
Facebook has adopted a Code of Conduct that we expect project participants to adhere to. Please [read the full text](https://code.facebook.com/pages/876921332402685/open-source-code-of-conduct) so that you can understand what actions will and will not be tolerated.
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+23-10
Original file line number
Diff line number
Diff line change
@@ -75,27 +75,40 @@ All functionality must be retained (and configuration given to the user) if they
75
75
76
76
1. Clone the repo with `git clone https://github.com/facebookincubator/create-react-app`
77
77
78
-
2. Run `npm install` in the root `create-react-app` folder.
78
+
2. Run `yarn` in the root `create-react-app` folder.
79
79
80
-
Once it is done, you can modify any file locally and run `npm start`, `npm test` or `npm run build` just like in a generated project.
80
+
Once it is done, you can modify any file locally and run `yarn start`, `yarn test` or `yarn build` just like in a generated project.
81
81
82
82
If you want to try out the end-to-end flow with the global CLI, you can do this too:
83
83
84
84
```
85
-
npm run create-react-app my-app
85
+
yarn create-react-app my-app
86
86
cd my-app
87
87
```
88
88
89
-
and then run `npm start` or `npm run build`.
90
-
91
-
*Note: if you are using yarn, we suggest that you use `yarn install --no-lockfile` instead of the bare `yarn` or `yarn install` because we [intentionally](https://github.com/facebookincubator/create-react-app/pull/2014#issuecomment-300811661) do not ignore or add yarn.lock to our repo.*
89
+
and then run `yarn start` or `yarn build`.
92
90
93
91
## Contributing to E2E (end to end) tests
94
92
95
93
**TL;DR** use the command `yarn e2e:docker` to run unit and e2e tests.
96
94
97
95
More detailed information are in the dedicated [README](/packages/react-scripts/fixtures/kitchensink/README.md).
98
96
97
+
## Tips for contributors using Windows
98
+
99
+
The scripts in tasks folder and other scripts in `package.json` will not work in Windows out of the box. However, using [Bash on windows](https://msdn.microsoft.com/en-us/commandline/wsl/about) makes it easier to use those scripts without any workarounds. The steps to do so are detailed below:
100
+
101
+
### Install Bash on Ubuntu on Windows
102
+
103
+
A good step by step guide can be found [here](https://www.howtogeek.com/249966/how-to-install-and-use-the-linux-bash-shell-on-windows-10/)
104
+
105
+
### Install Node.js and yarn
106
+
Even if you have node and yarn installed on your windows, it would not be accessible from the bash shell. You would have to install it again. Installing via [`nvm`](https://github.com/creationix/nvm#install-script) is recommended.
107
+
108
+
### Line endings
109
+
110
+
By default git would use `CRLF` line endings which would cause the scripts to fail. You can change it for this repo only by setting `autocrlf` to false by running `git config core.autocrlf false`. You can also enable it for all your repos by using the `--global` flag if you wish to do so.
111
+
99
112
## Cutting a Release
100
113
101
114
1. Tag all merged pull requests that go into the release with the relevant milestone. Each merged PR should also be labeled with one of the [labels](https://github.com/facebookincubator/create-react-app/labels) named `tag: ...` to indicate what kind of change it is.
@@ -104,13 +117,13 @@ More detailed information are in the dedicated [README](/packages/react-scripts/
104
117
4. Note that files in `packages/create-react-app` should be modified with extreme caution. Since it’s a global CLI, any version of `create-react-app` (global CLI) including very old ones should work with the latest version of `react-scripts`.
105
118
5. Create a change log entry for the release:
106
119
* You'll need an [access token for the GitHub API](https://help.github.com/articles/creating-an-access-token-for-command-line-use/). Save it to this environment variable: `export GITHUB_AUTH="..."`
107
-
* Run `npm run changelog`. The command will find all the labeled pull requests merged since the last release and group them by the label and affected packages, and create a change log entry with all the changes and links to PRs and their authors. Copy and paste it to `CHANGELOG.md`.
120
+
* Run `yarn changelog`. The command will find all the labeled pull requests merged since the last release and group them by the label and affected packages, and create a change log entry with all the changes and links to PRs and their authors. Copy and paste it to `CHANGELOG.md`.
108
121
* Add a four-space indented paragraph after each non-trivial list item, explaining what changed and why. For each breaking change also write who it affects and instructions for migrating existing code.
109
122
* Maybe add some newlines here and there. Preview the result on GitHub to get a feel for it. Changelog generator output is a bit too terse for my taste, so try to make it visually pleasing and well grouped.
110
123
6. Make sure to include “Migrating from ...” instructions for the previous release. Often you can copy and paste them.
111
-
7.After merging the changelog update, create a GitHub Release with the same text. See previous Releases for inspiration.
112
-
8.**Do not run `npm publish`. Instead, run `npm run publish`.**
113
-
9.Wait for a long time, and it will get published. Don’t worry that it’s stuck. In the end the publish script will prompt for versions before publishing the packages.
124
+
7.Run `npm run publish`. (It has to be `npm run publish` exactly, not just `npm publish` or `yarn publish`.)
125
+
8.Wait for a long time, and it will get published. Don’t worry that it’s stuck. In the end the publish script will prompt for versions before publishing the packages.
126
+
9.After publishing, create a GitHub Release with the same text as the changelog entry. See previous Releases for inspiration.
114
127
115
128
Make sure to test the released version! If you want to be extra careful, you can publish a prerelease by running `npm run publish -- --tag next` instead of `npm run publish`.
0 commit comments