Blocklet GitHub Actions

如果你使用的是 GitHub Actions 来管理 Blocklet 应用的打包、发布、部署等流程，那么你将在本文中更高效的 Blocklet 应用部署指南。

Action workflow 是什么？#

action-workflow 是我们在大量的 Blocklet 应用开发实践中总结出来的快捷发布流程。

借助于 action-workflow，我们能够快速的给每个 Blocklet 应用配置 CI 中的流程，在节省了开发时间的基础上，我们同样也节省掉了 CI 中的调试时间成本。

如何使用 Action workflow？#

首先你的项目需要先创建一个 .github 文件夹，来开启 GitHub Actions 功能

然后创建一个在 .github 中创建 workflows/main.yml 文件，并配置一些必备的初始化流程。比如 git checkout、dependencies install 等。

一切就绪之后，增加以下内容用来接入 Blocklet action-workflow 功能：

• skip-deps：是否跳过 blocklet-server 环境准备步骤，默认为 false
• skip-bundle：是否跳过 bundle 步骤，默认为 false
• skip-upload：是否跳过上传 Blocklet 应用到 Blocklet Store 步骤，默认为 true
• skip-deploy：是否跳过部署 Blocklet 应用到指定的 Blocklet Server 步骤，默认为 true
• skip-release：是否跳过发布 Github Release 步骤，默认为 false
• skip-readme：是否跳过更新 README.md 文件步骤，默认为 false
• deps-server-version：指定全局安装的 @blocklet/cli 版本，默认值是 latest，更多的版本号名称可以来这里查找 https://www.npmjs.com/package/@blocklet/cli?activeTab=versions
• deps-npm-client 使用哪个包管理器来安装 @blocklet/cli，默认值是 yarn，根据项目自身来调整
• working-directory：执行 Blocklet action-workflow 的目录，常用于 monorepo 中，同时存在多个 Blocklet 应用需要进行打包、上传、发布等步骤，默认为 ./
• bundle-command：Blocklet 应用打包的命令，一般情况下都是 npm run bundle，如果 skip-bundle 不为 true，则该项为必填项
• store-endpoint：Blocklet Store 的网址，可自由配置需要将应用上传到哪个 Blocklet Store，如果 skip-upload 不为 true，则该项为必填项
• store-access-token：在 Blocklet Store 中申请的密钥，需要先注册为对应 Blocklet Store 的开发者，然后申请一个上传密钥，如果 skip-upload 不为 true，则该项为必填项。更详细的内容请参考：Blocklet Store
• store-developer-did：开发者在对应 Blocklet Store 中的开发者 ID，当需要上传一个付费的 Blocklet 时，该项是必填项。更详细的内容请参考：Blocklet Store
• server-endpoint：要部署的 Blocklet Server 地址。（当 skip-deploy 不为空时）。更详细的内容请参考：Blocklet Deploy
• server-access-key：在 Blocklet Server 创建的 Access Key。（当 skip-deploy 不为空时）。更详细的内容请参考：Blocklet Deploy
• server-access-secret：在 Blocklet Server 创建的 Access Secret。（当 skip-deploy 不为空时）。更详细的内容请参考：Blocklet Deploy
• deploy-app-did：将当前应用部署在哪一个 Blocklet 应用下（成为其子组件），如果需要将该应用作为子组件来部署，则需要填写该项。更详细的内容请参考：Blocklet Deploy
• deploy-mount-point：该应用作为子组件部署时，配置其挂载的路径，如果需要将该应用作为子组件来部署，则需要填写该项。更详细的内容请参考：Blocklet Deploy
• slack-webhook：配置一个 slack 的 webhook，用于在 Blocklet 应用成功部署后发一个 slack 通知。
• github-token：配置一个具有 write 权限的 token，该 token 将用于在 CI 中更新项目的 README.md 文件