Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Changelog] Update Changelog with breaking changes #1562

Merged

Conversation

hugtalbot
Copy link
Contributor

Update ChangeLog to better guide users when facing issues with recent breaking PRs


This PR:

  • builds with SUCCESS for all platforms on the CI.
  • does not generate new warnings.
  • does not generate new unit test failures.
  • does not generate new scene test failures.
  • does not break API compatibility.
  • is more than 1 week old (or has fast-merge label).

Reviewers will merge only if all these checks are true.

@hugtalbot hugtalbot added pr: fast merge Minor change that can be merged without waiting for the 7 review days pr: status to review To notify reviewers to review this pull-request labels Oct 23, 2020
@hugtalbot hugtalbot added this to Doing in User Experience via automation Oct 23, 2020
- [All] Uniform size type [#1515](https://github.com/sofa-framework/sofa/pull/1515)
- [All] Change index_type from size_t to uint [#1514](https://github.com/sofa-framework/sofa/pull/1514)
- [All] Standardize index type for Vector/Matrix templates [#1453](https://github.com/sofa-framework/sofa/pull/1453)
- Ongoing [cleaning of the Link implementation](https://github.com/sofa-framework/sofa/issues/1526)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would break the breaking into 2 parts here:

  • The big big breaking (sofa ng + size_t) and the usual breaking


- Ongoing [SOFA-NG project](https://github.com/sofa-framework/sofa/issues/1527) generate several breaking changes due to modularization. It currently targets SOFA packages (SofaMisc, [SofaGeneral](https://github.com/sofa-framework/sofa/issues/1529) and soon SofaCommon), as well as SofaKernel (SofaBase\*, SofaCore, SofaHelper, SofaSimulation). Follow the [progress of the project online](https://github.com/sofa-framework/sofa/projects/9#card-47075575).
- [Modularization] SofaMisc* (Revival) [#1520](https://github.com/sofa-framework/sofa/pull/1520)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would put a line before like:
Any cmake configuration error could come from PR Y
and before the size_t change: any compilation error link to type missmatch or unknow signature method could come from PR X

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the feedback @epernod

@guparan guparan changed the title [ChangeLog] Update ChangeLog with breaking changes [Changelog] Update Changelog with breaking changes Oct 27, 2020
@hugtalbot hugtalbot added pr: status ready Approved a pull-request, ready to be squashed and removed pr: status to review To notify reviewers to review this pull-request labels Oct 28, 2020
@fredroy fredroy merged commit 01dcc0a into sofa-framework:master Oct 28, 2020
User Experience automation moved this from Doing to Done Oct 28, 2020
@guparan guparan added this to the v20.12 milestone Nov 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: fast merge Minor change that can be merged without waiting for the 7 review days pr: status ready Approved a pull-request, ready to be squashed
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants