Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add breaking changes in release notes

See original GitHub issue

As I stated in another issue (#71), some breaking changes have been shipped with v10 but are not mentioned anywhere, such as:

postRobot.CONFIG not existing anymore (breaking builds if you used to disable logs using postRobot.CONFIG.LOG_LEVEL)
.send() now only accepting a window object instead of an iframe, also breaking tests (induced by https://github.com/krakenjs/post-robot/commit/675ddec541013b4ed5cbda0b4e6ba6a499193076#diff-bf171c73c84cd3085514c56671eb2a5cL1)

It would be great to add a list of breaking changes made between two major releases 😃

Issue Analytics

State:
Created 5 years ago
Reactions:6
Comments:5 (2 by maintainers)

Top GitHub Comments

1reaction

bluepnumecommented, Mar 7, 2019

Agreed on the proposal for a changelog 👍

0reactions

bluepnumecommented, Mar 7, 2019

There should only be logs in debug mode now. By default that’s off, so you shouldn’t see any logs. I probably need to set up a webpack build to generate a dev bundle with debug mode, for local testing.

The latest release attempts to simplify the public interface of post-robot a fair bit. on and send should cover every possible use case. Please let me know if you find something they don’t cover.

Top Results From Across the Web

Changelog best practices - Web development co-pilot

Introduce a section for each release. Include version, release date, and a list of grouped changes: new features, bug fixes, breaking changes. Resources:....

How to automate your releases, versioning & release notes ...

In this article we'll explore how to automate releases, changelog, release notes generation and semantic versioning via semantic-release.

Add breaking changes to GitHub release notes · Issue #2268

The release notes on GitHub are currently empty. It would be beneficial if these contained the breaking changes for each major release.

Keep a Changelog

If you do nothing else, list deprecations, removals, and any breaking changes in your changelog. Confusing Dates. Regional date formats vary throughout the ......

Release post updates - GitLab

Changes · Revision to Breaking Changes in 15.0 post · Remove Gitaly entry · Add kickoff video link · Revise release post plan...