ratify icon indicating copy to clipboard operation
ratify copied to clipboard
verified publisher icon ratify-project

Document process for tracking breaking changes

Open susanshi opened this issue 1 year ago • 2 comments

What would you like to be added?

This issue aims to document how to track breaking changes. As discussed in the community meeting:

  • the PR should contain a "!" to indicate this is breaking change. E.g. feat! , fix!
  • Breaking changes should be listed before new features in the release notes
  • Create a issue to help customer to mitigate the change

Anything else you would like to add?

No response

Are you willing to submit PRs to contribute to this feature?

  • [ ] Yes, I am willing to implement it.

susanshi avatar Jan 19 '24 00:01 susanshi

The actions should be copied to PR template

susanshi avatar Mar 14 '24 00:03 susanshi

We should also have a doc to define breaking change ( Plugin , CRD, Config File etc)

susanshi avatar Mar 14 '24 00:03 susanshi

documented at https://github.com/deislabs/ratify/blob/dev/BREAKING_CHANGE_AND_DEPRECATION.md

susanshi avatar May 16 '24 06:05 susanshi