fix: Document change detector breaking change

[fredcarle]

Relevant issue(s)

Resolves #1530

Description

This PR fixes the previous fix and adds a breaking change document to prevent the broken cycle in the change detector after the fix. Should have been part of the #1528 although the change detector was passing before merge.

Tasks

• I made sure the code is well commented, particularly hard-to-understand areas.
• I made sure the repository-held documentation is changed accordingly.
• I made sure the pull request title adheres to the conventional commit style (the subset used in the project can be found in tools/configs/chglog/config.yml).
• I made sure to discuss its limitations such as threats to validity, vulnerability to mistake and misuse, robustness to invalidation of assumptions, resource requirements, ...

How has this been tested?

make test:changes

Specify the platform(s) on which this was tested:

• MacOS

[shahzadlone]

Why did the change detector not catch that in the last PR? is it broken?

[codecov]

Codecov Report

Merging #1531 (dfb9568) into develop (20e9286) will decrease coverage by 0.05%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           develop    #1531      +/-   ##
===========================================
- Coverage    72.10%   72.05%   -0.05%     
===========================================
  Files          185      185              
  Lines        18295    18295              
===========================================
- Hits         13192    13183       -9     
- Misses        4060     4066       +6     
- Partials      1043     1046       +3     

see 4 files with indirect coverage changes

[shahzadlone]

question: Did you test that it fails even in this branch without the documentation? and then once the documentation is added it works?

[fredcarle]

question: Did you test that it fails even in this branch without the documentation? and then once the documentation is added it works?

I did. I basically recreated the changes on my fork without the regression and it works fine. Here we need the change documentation to prevent the regression from failing the change detector check.

[shahzadlone]

Thanks for taking care of this. Fingers crossed :P hopefully no more fails on develop.