前言
在开发过程中，经常需要在 GitHub 上记录版本更新信息，以便让用户更好地了解项目的发展情况。然而，GitHub 的 release 功能虽然简单易用，但不够直观，需要手动编辑 Markdown 文件。而 Trello 是一个知名的团队协作工具，大家都很熟悉，在这里介绍一个开源的 npm 包：trello-release-notes，可以将 GitHub Release 转换为 Trello 卡片，并以更加直观的方式展示版本更新信息。
本文将介绍 trello-release-notes 的安装和使用方法，希望对前端工程师有所帮助。
trello-release-notes 的安装
trello-release-notes 是一款基于 Node.js 的 npm 包，需要安装 Node.js 环境才能使用。安装 Node.js 环境后，使用 npm 命令安装 trello-release-notes：
npm install trello-release-notes -g
trello-release-notes 的使用
Step1：获取 Trello 信息
在使用 trello-release-notes 前，需要获取 Trello 的 API Key 和 Token。登录 Trello，将鼠标悬浮在头像上，选择“Account info”，进入账户信息页面，找到 API Key，复制到剪贴板。
接着，进入 Token 页面，点击“Generate Token”按钮生成 Token，也复制到剪贴板。
Step2：准备 Release
在 GitHub 项目中，使用 Release 的方式记录版本信息。进入到 Releases 页面，点击“Draft a new release”按钮，进行版本发布，输入版本号和标题，选择 pre-release 和 release 选项。
Step3：初始化 trello-release-notes
在命令行中，使用 trello-release-notes 命令初始化，并输入相应的参数。参数中包括 Trello API Key 和 Token，以及 GitHub 仓库名称和 Release 版本号。
trello-release-notes init --trelloApiKey <Trello API Key> --trelloToken <Trello Token> --repoName <GitHub repository name> --releaseName <GitHub release name>
Step4：将 Release 转换为 Trello 卡片
成功初始化后，运行 trello-release-notes 命令，将 Release 转换成 Trello 卡片，卡片将自动添加到 Trello 中。
trello-release-notes add
Step5：更新 Trello 卡片
如果需要对卡片进行更新，可以运行 trello-release-notes 命令，输入相应的参数和更新内容。
trello-release-notes update --cardName <Trello card name> --description <description> --labelName <labelName> --dueDate <dueDate> --attachments <attachments> --comment <comment>
示例代码
Step1：获取 Trello 信息
1.登录 Trello 2.获取 API Key 和 Token
Step2：准备 Release
1.进入 GitHub 项目中，点击 Releases 2.点击 Draft a new release，输入版本号和标题 3.选择 pre-release 和 release 选项
Step3：初始化 trello-release-notes
trello-release-notes init --trelloApiKey <Trello API Key> --trelloToken <Trello Token> --repoName <GitHub repository name> --releaseName <GitHub release name>
Step4：将 Release 转换为 Trello 卡片
trello-release-notes add
Step5：更新 Trello 卡片
trello-release-notes update --cardName <Trello card name> --description <description> --labelName <labelName> --dueDate <dueDate> --attachments <attachments> --comment <comment>
总结
本文介绍了 trello-release-notes 的安装和使用方法，希望对前端工程师能够提供一些参考和帮助。使用 trello-release-notes，可以将 GitHub Release 转换成 Trello 卡片，并以更加直观的方式展示版本更新信息，增强开发团队协作和项目质量。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600560d781e8991b448df18d