简体中文 | English
🎉 欢迎向 L7 贡献代码! 🎉
git clone https://github.com/antvis/L7 --depth=1
由于使用了 pnpm workspace,首先需要安装 pnpm
pnpm install
# 运行 DEMO
pnpm dev
其它命令:
pnpm site:dev
启动本地官网pnpm test:unit
运行单元测试pnpm test-cover
运行单元测试并查看代码覆盖率pnpm test:integration
运行集成测试pnpm build
构建源码包, 分别输出 umd, es 和 lib 目录根据 angular 规范 提交 commit,这样 history 看起来更加清晰。
提交 commit 的类型,包括以下几种
尽量用一句话清楚的描述这次提交做了什么,查看具体参考文档。
我们使用了 changesets 进行全自动的语义化发布,当我们开发完成后执行 changeset 并提交变更集。
pnpm run changeset
git add .
git commit -m "chore: commit changeset"
如果你有仓库的开发者权限,而且希望贡献代码,那么你可以创建分支修改代码提交 PR,AntV 开发团队会 review 代码合并到主干。
# 先创建开发分支开发,分支名应该有含义,避免使用 update、tmp 之类的
$ git checkout -b branch-name
# 提交代码,message 见下面的规范
$ git add . # git add -u 删除文件
$ git commit -m "fix: role.use must xxx"
$ git push origin branch-name
提交后就可以在 L7 创建 Pull Request 了。
由于谁也无法保证过了多久之后还记得多少,为了后期回溯历史的方便,请在提交 MR 时确保提供了以下信息。
详细流程 版本发布指南
去 GitHub Action 触发 Create bump version PR Action 执行,选择发布分支,触发 Action 执行
等待 Action 执行完成,执行完成会提一个变更版本的 PR
去确认 PR 版本变更内容,如果没有问题 approve PR,等待发布版本 Action 执行,期间会发布到 NPM、打 tag 到 Github、创建 GitHub Release
第 3 步成功,会进行钉钉消息通知,机器人自动合并 PR,后台自动部署新官网
第 3 步失败,会进行钉钉消息通知,去 GtiHub Action 查看失败原因
release
分支pnpm run changeset
脚本,创建本次版本发布变更集,执行完成 coomit 变更集pnpm run version-packages
脚本,更新要发布包的版本号和 Changelog,确认内容并 coomitpnpm run publish-packages
脚本,会发布包到 NPM、打 tag 到 GitHubrelease
分支变更内容,以提交 PR 方式合并到发布分支以预发 beta 为例,新增加一个功能,发布 beta 版本:
beta
分支pnpm exec changeset pre enter beta
命令🔗,进入 beta
预发模式beta
分支beta 版本发布验证完成后,合并到主分支发布流程:
pnpm exec changeset pre exit
命令🔗,退出预发模式beta
分支变更内容,以提交 PR 方式合并到主分支此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。