如何在 CI (github actions) 中自动化和发布文档？

Question

我想自动构建和发布docsGithub 上托管的开源打字稿项目。

我尝试了TypeDoc，生成的文档文件夹是23Mo。我不想将其提交到项目的存储库中。

理想情况下，在每个版本中，我想使用 github 操作来：

• 生成文档
• 将生成的docs文件夹推送到其自己的 github 存储库。

目前我添加了一个 npm 脚本来生成文档：docs: typedoc --out docs src这是我的 github 操作文件的起点：

name: Docs

on:
  release:
    branches:
      - master

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v1
      - name: Use Node.js
        uses: actions/setup-node@v1
        with:
          node-version: 12
      - name: Generate docs
        run: |
          npm ci
          npm run docs

通过此操作，我如何提交此生成的目录并将其推送到 github 上它自己的存储库？

（也许有一种更传统的方法可以做到这一点。请告诉我）

Answer 1

如果您想提交并推送更改，您可以参考 Github 市场中的一些操作，例如github-push或推送更改，看看它们是否适合您的情况。另外，你可以编写自己的脚本来调用Github的API，例如我使用Pygithub调用Github的APT来帮助我生成changelog并更新repo中的文件。