Skip to content

Commit

Permalink
improvement(project): breaking change in yml (element-plus#7593)
Browse files Browse the repository at this point in the history
- Add breaking change yaml example.
- Add breaking change list for 2.2.
  • Loading branch information
jw-foss authored May 9, 2022
1 parent 4873d83 commit 6bae2bf
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 0 deletions.
17 changes: 17 additions & 0 deletions breakings/2.2.0/button.yml
Original file line number Diff line number Diff line change
@@ -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 changes: 18 additions & 0 deletions breakings/breaking.yml.example
Original file line number Diff line number Diff line change
@@ -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'

0 comments on commit 6bae2bf

Please sign in to comment.