mirror of
https://github.com/element-plus/element-plus.git
synced 2024-12-15 02:40:46 +08:00
improvement(project): breaking change in yml (#7593)
- Add breaking change yaml example. - Add breaking change list for 2.2.
This commit is contained in:
parent
4873d833e9
commit
6bae2bffd0
17
breakings/2.2.0/button.yml
Normal file
17
breakings/2.2.0/button.yml
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
- scope: 'component'
|
||||||
|
name: 'el-button'
|
||||||
|
type: 'props'
|
||||||
|
version: '2.2.0'
|
||||||
|
commit_hash: 'a4aad5a'
|
||||||
|
description: |
|
||||||
|
We want to make text button more like a button, instead of like a text/link.
|
||||||
|
In addition with design changes, text button now looks more like a button.
|
||||||
|
Because the API `type` also represents how the button looks like, so we decided to add a
|
||||||
|
new API `text` to represent the text button.
|
||||||
|
props:
|
||||||
|
- api: 'type'
|
||||||
|
before: '"primary" | "success" | "warning" | "danger" | "info" | "text"'
|
||||||
|
after: '"primary" | "success" | "warning" | "danger" | "info"'
|
||||||
|
- api: 'text'
|
||||||
|
before: '-'
|
||||||
|
after: 'boolean'
|
18
breakings/breaking.yml.example
Normal file
18
breakings/breaking.yml.example
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
- scope: 'component' # package name under packages/*
|
||||||
|
name: 'el-button' # the name of which file you changed
|
||||||
|
type: 'props' # which API you have changed, must match the field the same level with the detailed changes, in this case "props"
|
||||||
|
version: '2.2.0' # which version this breaking change is going to make to.
|
||||||
|
commit_hash: 'a4aad5a'
|
||||||
|
description:
|
||||||
|
| # detailed description for the reason of this breaking change, you may also include links. Markdown supported.
|
||||||
|
We want to make text button more like a button, instead of like a text/link.
|
||||||
|
In addition with design changes, text button now looks more like a button.
|
||||||
|
Because the API `type` also represents how the button looks like, so we decided to add a
|
||||||
|
new API `text` to represent the text button.
|
||||||
|
props: # this is used for building a table in the breaking change list.
|
||||||
|
- api: 'type' # API name
|
||||||
|
before: '"primary" | "success" | "warning" | "danger" | "info" | "text"' # before changed
|
||||||
|
after: '"primary" | "success" | "warning" | "danger" | "info"' # after changed
|
||||||
|
- api: 'text'
|
||||||
|
before: '-'
|
||||||
|
after: 'boolean'
|
Loading…
Reference in New Issue
Block a user