简介
npm 是 Node.js 的包管理工具，对于前端开发来说，它是必不可少的工具之一。而 create-github-release-render-clubhouse-stories 是一个集成了 GitHub Release API 和 Clubhouse Story API 的 npm 包，它可以帮助我们更方便地在 GitHub 和 Clubhouse 中发布 Release 和关联 Story。
在本文中，我们将详细讲解 create-github-release-render-clubhouse-stories 的使用方法和相关注意事项，帮助大家更快地上手和使用它。
安装
使用 npm 安装 create-github-release-render-clubhouse-stories：
npm install create-github-release-render-clubhouse-stories --save-dev
安装完成后，我们就可以在项目中使用它了。
使用
初始化
在使用之前，我们需要先进行初始化。在初始化时，我们需要提供 GitHub 和 Clubhouse 的 API Token，以及需要发布 Release 的项目信息：
const createRelease = require('create-github-release-render-clubhouse-stories');
createRelease.init({
githubToken: 'YOUR_GITHUB_API_TOKEN',
clubhouseToken: 'YOUR_CLUBHOUSE_API_TOKEN',
owner: 'YOUR_GITHUB_REPO_OWNER',
repo: 'YOUR_GITHUB_REPO_NAME',
});所有的参数都是必选的。
创建 Release
在初始化完成后，我们就可以使用 createRelease 方法来创建 Release。在创建 Release 时，我们需要提供 Release 的名称、标签、描述和文件列表：
-- -------------------- ---- -------
----- ----------- - -
----- ---------
---- ---------
------------ ----- -- --- ----- ------- -- -- ----------
------- -
-------------------
--
--
----------------------------------------------- -- -
--------------------
-------------- -- -
-------------------
---当 Release 创建成功后，会返回 Release 的相关信息。
关联 Clubhouse Story
在 Release 创建后，我们还可以关联 Clubhouse Story。在关联 Clubhouse Story 时，我们需要提供 Story 的 ID 和 Release 的 ID：
const storyIds = [12345];
const releaseId = 1;
createRelease.renderClubhouseStories(storyIds, releaseId).then(() => {
console.log('Stories render success!');
}).catch((err) => {
console.error(err);
});当关联成功后，Story 的相关信息会自动添加到 Release 描述中。
示例代码
这里提供一个完整的示例代码，以供大家参考：
-- -------------------- ---- -------
----- ------------- - ----------------------------------------------------------
--------------------
------------ ------------------------
--------------- ---------------------------
------ -------------------------
----- ------------------------
---
----- ----------- - -
----- ---------
---- ---------
------------ ----- -- --- ----- ------- -- -- ----------
------- -
-------------------
--
--
----------------------------------------------- -- -
--------------------
----- -------- - --------
----- --------- - ----------
---------------------------------------------- ------------------ -- -
-------------------- ------ -----------
-------------- -- -
-------------------
---
-------------- -- -
-------------------
---总结
create-github-release-render-clubhouse-stories 是一个非常实用的 npm 包，它可以帮助我们更方便地在 GitHub 和 Clubhouse 中发布 Release 和关联 Story。在本文中，我们详细讲述了它的使用方法和相关注意事项，并提供了示例代码，希望大家能够更快地上手和使用它。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600560c081e8991b448df09f