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.

Sign up for GitHub

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

Jump to bottom

Crash the build during CI whenever linter warnings are encountered #944

Merged
merged 4 commits into from
Dec 3, 2016
Merged

Crash the build during CI whenever linter warnings are encountered #944

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bfc11ef
Added functionality to crash the build during CI whenever linter warn…
excitement-engineer Oct 22, 2016
90d1c39
Updated the docs with a description on how to use the build in CI
excitement-engineer Oct 28, 2016
2b57b8e
Fixed small typo
excitement-engineer Oct 29, 2016
93f687a
Fixed description of build error.
excitement-engineer Nov 27, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Updated the docs with a description on how to use the build in CI
  • Loading branch information
@excitement-engineer
excitement-engineer committed Oct 28, 2016
commit 90d1c3970d30859f862e487d2c043a47528b1d3d
21 changes: 18 additions & 3 deletions packages/react-scripts/template/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -788,7 +788,11 @@ Note that tests run much slower with coverage so it is recommended to run it sep

### Continuous Integration

By default `npm test` runs the watcher with interactive CLI. However, you can force it to run tests once and finish the process by setting an environment variable called `CI`. Popular CI servers already set it by default but you can do this yourself too:
By default `npm test` runs the watcher with interactive CLI. However, you can force it to run tests once and finish the process by setting an environment variable called `CI`.

When creating a build of your application with `npm run build` linter warnings are not checked by default. Like `npm test`, you can force the build to perform a linter warning check by setting the environment variable `CI`. If any warnings are encountered then the build fails.

Popular CI servers already set the environment variable `CI` by default but you can do this yourself too:

### On CI servers
#### Travis CI
Expand All @@ -805,6 +809,7 @@ cache:
- node_modules
script:
- npm test
- npm run build
```
1. Trigger your first build with a git push.
1. [Customize your Travis CI Build](https://docs.travis-ci.com/user/customizing-the-build/) if needed.
Expand All @@ -816,6 +821,10 @@ script:
set CI=true&&npm test
```

```cmd
set CI=true&&npm run build
```

(Note: the lack of whitespace is intentional.)

##### Linux, OS X (Bash)
Expand All @@ -824,9 +833,15 @@ set CI=true&&npm test
CI=true npm test
```

This way Jest will run tests once instead of launching the watcher.
```bash
CI=true npm run build
```

The test command will force Jest to run tests once instead of launching the watcher.

> If you find yourself doing this often in development, please [file an issue](https://github.com/facebookincubator/create-react-app/issues/new) to tell us about your use case because we want to make watcher the best experience and are open to changing how it works to accommodate more workflows.

If you find yourself doing this often in development, please [file an issue](https://github.com/facebookincubator/create-react-app/issues/new) to tell us about your use case because we want to make watcher the best experience and are open to changing how it works to accommodate more workflows.
The build command will check for linter warning and fail the build if any are found.

### Disabling jsdom

Expand Down