Karma: Document v2.0.0 breaking changes in CHANGELOG.md

Created on 28 Dec 2017  路  6Comments  路  Source: karma-runner/karma

Expected behaviour

  • 2.0.0 release signifies breaking changes from v 1.x.
  • Change log clarifies just what those breaking changes are and what they mean for adopters.

Actual behaviour

  • There's a 2.0.0 release
  • It has an entry in the change log
  • But it's not clear from the change log what the breaking change is and what it means for adopters.

Steps to reproduce the behaviour

  1. View the change log
  2. Try to understand what breaking change led to the major version rev
  3. Be frustrated.

All 6 comments

Guessing it's because Karma dropped support for Node.js 0.10 and 0.12.

The changelog error has been fixed.

I don't think this issue wrt the 2.0.0 changelog entry has been addressed.

Reading the changelog, looking at the 2.0.0 release, it still doesn't seem apparent what the breaking change was. Contrast the treatment in the 3.0.0 release, where breaking changes are called out thanks to #3109 .

Please open a PR to fix the log if you like.

The breaking change was
https://github.com/karma-runner/karma/commit/ec92ea9
but it was not marked so in the description and thus the script did not emit the changelog entry.

In any case the supported version is 3.0.

It's a little odd that https://github.com/karma-runner/karma/commit/ec92ea9 is the breaking change yielding 2.0.0 when that change is also in 1.7.1. Is this a matter of the 1.7.1 patch release inadvertently included a breaking change?

The current supported version is 3.0. That is all that really matters.

I don't know of any breaking change in 1.7.1.

Was this page helpful?
0 / 5 - 0 ratings