Skip to content

Commit 1cf5f51

Browse files
committed
docs: append development and release content
1 parent 51ffc1e commit 1cf5f51

File tree

1 file changed

+74
-1
lines changed

1 file changed

+74
-1
lines changed

README.md

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,76 @@
11
# storybook-ts-boilerplate
22

3-
Boilerplate for storybook and Typescript.
3+
Boilerplate for storybook and Typescript.
4+
5+
## Integrated
6+
7+
- Storybook
8+
- React.js
9+
- Typescript
10+
- Jest
11+
- commitlint
12+
- conventional-changelog
13+
- husky
14+
15+
## :wrench: 本地开发
16+
17+
### **clone & npm install**
18+
19+
```bash
20+
ssh://[email protected]:10022/dt-insight-front/infrastructure/storybook-ts-boilerplate.git
21+
npm install
22+
```
23+
24+
### 启动本地服务器
25+
26+
```bash
27+
npm run storybook
28+
```
29+
30+
### 组件开发
31+
32+
+ src/components 目录下编写组件
33+
+ src/stories 目录下编写 storybook 文档
34+
+ npm run storybook 本地文档预览
35+
36+
## 静态服务部署构建
37+
38+
```bash
39+
npm run build-storybook
40+
```
41+
42+
**组件发布至 npm**
43+
**在按照一些列组件开发规范流程下,测试组件无问题后进行组件发布**
44+
45+
```bash
46+
# output to lib
47+
npm run compile
48+
# Publish to registry
49+
npm publish
50+
```
51+
52+
## 版本发布
53+
54+
```bash
55+
# 默认分支为 master , 发布为此版本更新
56+
$ npm run release
57+
58+
#【自定义】版本发布名称为 v1.0.0-test
59+
$ npm run release -- -r v1.0.0-test
60+
61+
# 指定升级版本为【次】版本号
62+
$ npm run release -- -r minor
63+
64+
# 指定升级版本为【主】版本号
65+
$ npm run release -- -r major
66+
67+
# 指定升级版本为【修订】版本号
68+
$ npm run release -- -r patch
69+
70+
# 指定发布分支
71+
$ npm run release -- -b branchName
72+
73+
# 指定发布分支以及发布名称
74+
$ npm run release -- -b branchName -r versionName
75+
76+
```

0 commit comments

Comments
 (0)