README.md

【codechina-workflow】Git 源码管理工具  

### 更新记录  
**1.0.0（2021-04-12）**  
支持将项目托管到 CSDN 旗下代码托管平台： codechina（下统称 code）。  

### HBuilderX插件通用注意事项  
#### 版本要求   
HBuilder 版本需保证 3.0.0 以上
#### 安装  
HBuilder 3.1.8 及以上版本，均默认集成本插件，无需手动安装。  
3.1.8 以下版本，可点击 这里 下载。  
Mac 电脑用户可直接将下载好的压缩包解压到 plugins 目录下，重启编辑器即可生效。  
Windows 电脑用户需要先确保安装了 git-bash，git-bash [下载地址](https://git-scm.com/download/win)。  
#### 介绍  
插件名称：  
codechina-workflow  
插件开发者：   
csdn code 研发团队  
插件用途：  
HBuilder 创建的项目支持直接托管到 code，项目完成托管以后，可以直接在 code 完成项目的版本发布、合并请求、问题反馈等管理。  
使用方法：
3.1.8 及以上版本已经默认集成了 codechina-workflow 插件，并且在新建项目时，均可以选择勾选 **项目托管**，在创建项目时，同步将项目托管到 code 平台；

![项目创建](./locales/images/project_create.png)

所有可以安装插件的编辑器，均可在项目创建以后，在项目目录下 **右键** 选择 **托管当前项目**  

![右键托管](./locales/images/menu_right.png)

项目托管成功后，编辑器右下角将弹窗返回项目在 code 平台上的托管地址，您可点击直接访问和管理，默认创建后为隐私项目。

![成功](./locales/images/success.png)

![详情](./locales/images/project_show.png)

这样本地刚才创建的项目就已经在 code 平台上创建并关联起来了，接下来需要将自己的代码 push 到 code 平台的仓库中：

```
git add .
git commit -m 'first commit'
git push origin master
```

![详情](./locales/images/project_show2.png)

#### 常见问题：  
1、补充手机号：  
根据国家相关法律法规，发布内容需要补充用户手机号，所以在托管仓库时，需要在 Dcloud 用户中心补充用户手机号。  
2、使用哪个账号登陆 code 查看自己的项目：  
在登陆 code 查看自己托管的项目时，需要选择 HBuilder 第三方登陆。 

![登陆](./locales/images/auth_login.png)

3、如何多平台托管：  
如果项目未在其他平台托管，则默认将项目仓库 remote 命名为 origin，如果 origin 已经被占用，插件将采用 codechina 命名仓库 remote url。  
其他问题，您可在插件官方托管地址进行反馈： [反馈地址](https://codechina.csdn.net/codechina_dev/codechina-hbuilder-plugin/-/issues)  

#### 注意事项  
我们在 code 自动为用户创建了 access_token，并根据 access_token 采用 oauth2 的方式设置了项目仓库的 remote，为了保证您能够正常推送代码，请勿删除个人设置中的 hbuilder 访问令牌。

### 隐私、权限声明  
本插件需要申请的系统权限列表：  
仓库的文件读写。  
本插件采集的数据、发送的服务器地址、以及数据用途说明：  
数据：用户邮箱、手机号以及创建的项目名称；  
发送的服务器地址：  
passport.csdn.net, codechina.csdn.net；  
数据用途：  
授权登陆并将用户选择的项目托管到 code。  

### 许可协议   
无