[Documentation] The changelog is not mentioning a breaking change.

Description

See https://stackoverflow.com/questions/56416187/sweetalert2-typeerror-this-is-undefined-after-v8-upgrade/

TL;DR: The changelog is not mentioning a breaking change.

Before (I don’t know exactly when since the changelog do not talk about it) calling Swal() was enough to launch the popup, now (I don’t know since when) Swal.fire() is mandatory. The issue is that the Changelog don’t talk about that.

More information in the StackOverflow post.

Current behavior

Issue in the documentation not in the code!

Expected behavior

Issue in the documentation not in the code!

Live demo

Issue in the documentation not in the code!

[limonte]

Thank you @noraj and @gverni for the constructive discussion, the PR is merged now 👍

[gverni]

Are in the CHANGELOG.md but not Breaking change # 1 - swal(…) -> Swal.fire(…)

@noraj as I reported already in my comment, the breaking change for Swal.fire() is already in commit f581352 under title “BREAKING CHANGE: remove withNoNewKeyword enhancer”. I agree that this does not explicitly mention the fire() method, but this can be seen inside the commit message.

I let @limonte comment on the PR for the changelog. Keep in mind that the changelog is automatically generated using the commit title, and there is no commit with an explicit title referring to Swal.fire(). If we have to change the changelog, then I would rather add the link to the release note.