45 lines
No EOL
2.5 KiB
Markdown
45 lines
No EOL
2.5 KiB
Markdown
# 发布文章生成器 CLI 工具
|
||
|
||
这是一个专为 WooCommerce 生成草稿发布文章而设计的 CLI 工具。
|
||
通过该工具生成的文章将以草稿形式发布到 <https://developer.woocommerce.com>。
|
||
|
||
如果您没有 WordPress.com 认证令牌，也可以生成文章的 HTML 表示形式。
|
||
|
||
## 设置
|
||
|
||
1. 确保已在 monorepo 中运行 `pnpm i`。
|
||
2. 确保已添加包含环境变量的 `.env` 文件。如果使用 `--outputOnly` 参数，`WCCOM_TOKEN` 是可选的，但 `GITHUB_ACCESS_TOKEN` 是必需的。如需生成令牌的帮助，请参阅[文档](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)。要静默所有 CLI 输出，请将 `LOGGER_LEVEL` 设置为 `"silent"`。
|
||
3. 请注意，`.env` 文件应位于您运行命令的同一路径下。
|
||
4. 通过 npm 脚本运行工具，例如 `pnpm release-post release "6.8.0" --outputOnly`
|
||
5. 有关各个选项的更多帮助，请运行帮助命令 `pnpm release-post <command> --help`。例如 `pnpm release-post rc --help`
|
||
|
||
## 发布草稿文章
|
||
|
||
如果您省略 `--outputOnly` 标志，此工具将为您将草稿文章发布到 `https://developer.woocommerce.com`。但这需要一些首次设置：
|
||
|
||
1. 在 WordPress.com 上[此处](https://developer.wordpress.com/apps/)创建一个应用。
|
||
2. 推荐设置：
|
||
- 名称可以是任何内容
|
||
- 描述可以留空
|
||
- 网站 URL 只需填写 `http://localhost`
|
||
- 重定向 URL，默认情况下应添加：`http://localhost:3000/oauth`
|
||
- JavaScript 来源填写 `http://localhost`
|
||
- 类型 - 选择 "Web"
|
||
3. 创建应用后，您可以返回应用列表并点击"管理应用"。
|
||
4. 记下 `client secret` 和 `client id`。
|
||
5. 在您的 `.env` 文件中，将客户端密钥添加到 `WPCOM_OAUTH_CLIENT_SECRET` 变量，将客户端 ID 添加到 `WPCOM_OAUTH_CLIENT_ID` 变量。
|
||
|
||
## 仅生成贡献者列表
|
||
|
||
如果您还没有最终发布版本，可以生成一个 HTML 贡献者列表，以便复制粘贴到空白文章中。
|
||
|
||
只需运行 `pnpm release-post contributors "<currentVersion>" "<previousVersion>"` 即可。
|
||
|
||
## 高级
|
||
|
||
如果您无法在本地主机的 3000 端口运行任何程序，可能需要覆盖 OAuth 的重定向 URI。
|
||
|
||
步骤：
|
||
|
||
1. 在 `.env` 文件的 `WPCOM_OAUTH_REDIRECT_URI` 变量中添加您首选的重定向 URI。例如 `http://localhost:4321/oauth`
|
||
2. 在 [WordPress.com](https://developer.wordpress.com/apps/) 上创建应用时，请确保设置的重定向 URL 与 `.env` 中设置的一致。 |
