breaking.yml.example 1.1 KB

123456789101112131415161718
  1. - scope: 'component' # package name under packages/*
  2. name: 'el-button' # the name of which file you changed
  3. type: 'props' # which API you have changed, must match the field the same level with the detailed changes, in this case "props"
  4. version: '2.2.0' # which version this breaking change is going to make to.
  5. commit_hash: 'a4aad5a'
  6. description:
  7. | # detailed description for the reason of this breaking change, you may also include links. Markdown supported.
  8. We want to make text button more like a button, instead of like a text/link.
  9. In addition with design changes, text button now looks more like a button.
  10. Because the API `type` also represents how the button looks like, so we decided to add a
  11. new API `text` to represent the text button.
  12. props: # this is used for building a table in the breaking change list.
  13. - api: 'type' # API name
  14. before: '"primary" | "success" | "warning" | "danger" | "info" | "text"' # before changed
  15. after: '"primary" | "success" | "warning" | "danger" | "info"' # after changed
  16. - api: 'text'
  17. before: '-'
  18. after: 'boolean'