Skip to content

Commit 8d59213

Browse files
committed
Updated README to include migration guide
1 parent ebf23ce commit 8d59213

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

README.md

Lines changed: 39 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -192,9 +192,42 @@ please be as specific as possible including operating system, `node`, `grunt`, a
192192
npm --versions
193193
```
194194

195-
## Migrating from before `v1.0.0` release
195+
## Migration notes
196196

197-
If you are updating to `v1.0.0`, you'll need to update your Gruntfile.
197+
### v1.x -> v2.x
198+
199+
The `spec` reporter configuration has changed for v2 of this plugin. The following is an example of the change in configuration that is needed. This is not an exhaustive list: refer to the [jasmine-spec-reporter](https://github.com/bcaudan/jasmine-spec-reporter) for a full reference of the configuration options.
200+
201+
``` js
202+
// v1
203+
reporters: {
204+
spec: {
205+
colors: true,
206+
displayStacktrace: 'summary',
207+
displaySuccessfulSpec: true
208+
}
209+
}
210+
211+
// v2
212+
reporters: {
213+
spec: {
214+
colors: {
215+
enabled: true
216+
},
217+
summary: {
218+
displayStacktrace: true
219+
},
220+
spec: {
221+
displaySuccessful: true
222+
}
223+
}
224+
}
225+
```
226+
227+
228+
### v0.x -> v1.x
229+
230+
If you are updating to `v1.x`, you'll need to update your Gruntfile.
198231

199232
The following example outlines the changes needed. It assumes the following folder structure:
200233

@@ -250,7 +283,10 @@ app/
250283
Please note that the junit reporter is no longer available. If you are using this reporter and wish to update to v1, please open a new issue and we'll see if we can get it added back in. Even better, submit a PR :smile:
251284

252285
## Release History
253-
286+
* `unreleased`
287+
- **Breaking changes alert! Ensure you read the migration guide before updating from previous versions**
288+
- Updated to jasmine-spec-reporter v3.1.0. Older style configuration needs to be updated, see migration guide for more details.
289+
- Removed support for Node.js v0.10
254290
* `v1.1.1` (2016-08-29)
255291
- Istanbul `v0.4.5` and using `data.src` instead of `fileSrc` for compatibility #59
256292
* `v1.1.0` (2016-08-23)

0 commit comments

Comments
 (0)