Как автоматизировать и опубликовать sh документов в CI (действия на github)?

Question

Я хочу автоматизировать сборку и публикацию docs проекта машинописного текста с открытым исходным кодом, размещенного на Github.

Я попробовал TypeDo c, и сгенерированная папка с документами 23Мо. Я не хочу фиксировать это в репо проекта.

В идеале, в каждом выпуске я хотел бы использовать действия github, чтобы:

• сгенерировать документы
• pu sh, которые сгенерировали папку 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

Из этого действия, как я могу зафиксировать sh этот сгенерированный каталог и поместить его в собственное хранилище на github?

(Возможно, есть более традиционный способ сделать это. Дайте мне знать)

Answer 1

Если вы хотите зафиксировать и изменить sh pu, вы можете сослаться на некоторые действия на торговой площадке Github, например github-pu sh или pu sh changes чтобы увидеть, подходят ли они к вашей ситуации. Кроме того, вы можете написать свой собственный сценарий для вызова API Github, например, я использую Pygithub для вызова APT Github, чтобы помочь мне создать журнал изменений и обновить файл в репозитории.