grid-npm-auto-publish
Version:
138 lines (101 loc) • 2.19 kB
Markdown
# 开发工作流程示例
## 场景:修改npm包功能
### 1. 开始开发
```bash
# 在npm包项目中
cd /path/to/grid-npm-auto-publish
# 设置开发环境
npm run setup link
# 启动监听模式(如果有构建过程)
npm run setup watch
```
### 2. 在业务项目中链接
```bash
# 在业务项目中
cd /path/to/your-business-project
# 链接到本地npm包
npm link grid-npm-auto-publish
# 验证链接
npm ls grid-npm-auto-publish
```
### 3. 开发调试
现在您可以:
- 在npm包项目中修改代码
- 在业务项目中实时看到效果
- 无需每次发布新版本
### 4. 测试修改
```bash
# 在npm包项目中运行测试
npm run setup test
# 检查开发状态
npm run setup status
```
### 5. 完成开发
```bash
# 在业务项目中取消链接
npm unlink grid-npm-auto-publish
# 在npm包项目中取消全局链接
npm run setup unlink
# 提交更改
git add .
git commit -m "feat: 添加新功能"
```
### 6. 发布新版本
```bash
# 快速发布
npm run quick-release patch
# 或者使用传统方式
node scripts/release.js patch
```
## 常见场景
### 场景1:紧急修复
```bash
# 快速修复并发布
npm run setup link
# 修改代码
npm run quick-release patch --skip-tests
```
### 场景2:功能开发
```bash
# 长期开发
npm run setup link
npm run setup watch
# 开发完成后
npm run quick-release minor
```
### 场景3:版本回滚
```bash
# 回滚到上一个版本
git reset --hard HEAD~1
git tag -d v1.0.1
git push origin HEAD --force
```
## 最佳实践
1. **开发前检查状态**:`npm run setup status`
2. **使用语义化版本**:patch/minor/major
3. **及时取消链接**:避免影响其他项目
4. **编写测试**:确保代码质量
5. **记录变更**:更新README和CHANGELOG
## 故障排除
### 问题:修改不生效
```bash
# 检查链接状态
npm ls grid-npm-auto-publish
# 重新链接
npm unlink grid-npm-auto-publish
npm link grid-npm-auto-publish
```
### 问题:构建失败
```bash
# 检查构建脚本
npm run build
# 检查依赖
npm install
```
### 问题:发布失败
```bash
# 检查Git状态
git status
# 检查NPM_TOKEN配置
echo $NPM_TOKEN
```