diff --git a/README.md b/README.md index a1ec2c471155824c7e3515eb5d24599ad5fb8c81..830ff3b2768fa069128da5adbcd6b18655d25400 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,76 @@ 【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)。 -#### 介绍 +支持将项目托管到 CSDN 旗下代码托管平台: Code China。 + +*后面 Code China 统称为 code。* + +### HBuilderX插件使用注意事项: + +#### 版本要求: + +HBuilder 版本不能低于 3.1.8 + +#### 安装: + +1、使用编辑器创建项目时,如果勾选了“项目托管”,编辑器将自动安装插件; +2、您可以在插件市场直接搜索“codechina-workflow”下载,并解压缩到 plugin 目录下完成手动安装。 + +#### 介绍: + 插件名称: codechina-workflow + 插件开发者: csdn code 研发团队 + 插件用途: HBuilder 创建的项目支持直接托管到 code,项目完成托管以后,可以直接在 code 完成项目的版本发布、合并请求、问题反馈等管理。 + 使用方法: -3.1.8 及以上版本已经默认集成了 codechina-workflow 插件,并且在新建项目时,均可以选择勾选 **项目托管**,在创建项目时,同步将项目托管到 code 平台; +3.1.8 及以上版本已经默认接入了 codechina-workflow 插件,在新建项目时可以选择勾选 **项目托管**,此操作会在编辑器创建好项目之后,将项目同步到 code 平台; ![项目创建](./locales/images/project_create.png) -所有可以安装插件的编辑器,均可在项目创建以后,在项目目录下 **右键** 选择 **托管当前项目** +除创建项目可以启用托管功能外,您还可以在编辑器菜单栏内,右键点击项目名称,选在 **托管当前项目**功能,托管已经存在的项目。 -![右键托管](./locales/images/menu_right.png) +![右键托管](./locales/images/create.png) -项目托管成功后,编辑器右下角将弹窗返回项目在 code 平台上的托管地址,您可点击直接访问和管理,默认创建后为隐私项目。 +#### 常见问题: -![成功](./locales/images/success.png) +1、用户信息授权: +将代码托管到 code 时,需要我们需要您同意授权使用您的用户信息登陆 code 平台,其中手机号和邮箱是必须信息,如果取消授权手机号和邮箱,将导致操作失败。 -![详情](./locales/images/project_show.png) +2、补充手机号: +根据国家相关法律法规,发布内容需要补充用户手机号,所以托管仓库时,需要在 Dcloud 用户中心补充用户手机号。 -这样本地刚才创建的项目就已经在 code 平台上创建并关联起来了,接下来需要将自己的代码 push 到 code 平台的仓库中: +3、使用哪个账号登陆 code 查看自己的项目: +在登陆 code 查看自己托管的项目时,您可以在 csdn 登陆页面选择 HBuilder 第三方登陆或者您在 Dcloud 平台绑定的手机号加验证码的方式登陆 code。 -``` -git add . -git commit -m 'first commit' -git push origin master -``` +4、如何多平台托管: +如果项目未在其他平台托管,则默认将项目仓库 remote 命名为 origin,如果 origin 已经被占用,插件将采用 codechina 命名仓库 remote url。 -![详情](./locales/images/project_show2.png) +其他问题,您可在插件官方托管地址进行反馈: [反馈地址](https://codechina.csdn.net/codechina_dev/codechina-hbuilder-plugin/-/issues) -#### 常见问题: -1、补充手机号: -根据国家相关法律法规,发布内容需要补充用户手机号,所以在托管仓库时,需要在 Dcloud 用户中心补充用户手机号。 -2、使用哪个账号登陆 code 查看自己的项目: -在登陆 code 查看自己托管的项目时,需要选择 HBuilder 第三方登陆。 +#### 注意事项: -![登陆](./locales/images/auth_login.png) +我们在 code 自动为用户创建了 access_token,并根据 access_token 采用 oauth2 的方式设置了项目仓库的 remote,为了保证您能够正常推送和获取代码,请勿删除个人设置中的 hbuilder 访问令牌。 -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。 +授权登陆并 csdn 将用户选择的项目托管到 csdn code 平台。 -### 许可协议 +### 许可协议: 无 \ No newline at end of file diff --git a/locales/images/create.png b/locales/images/create.png new file mode 100644 index 0000000000000000000000000000000000000000..f912eb9d1de76243c1b657b4ace6723cb3b62592 Binary files /dev/null and b/locales/images/create.png differ