docC github pages deploy

Развертывание DocC Github Pages: развертывание созданного статического сайта DocC на страницах Github.

• Требования
• Использование
• Интеграция
• Авторы
• Лицензия

Требования

Платформа	Статус
Ubuntu-последний	Протестировано

Использование

См. action.yml.

Обязательно установите последнюю версию тега.

В качестве примера:

 name : worksapce
on :
  push :
    branches :
      - ' ** '
jobs :
  build_deploy_site :
    runs-on : ubuntu-latest
    environment :
      name : github-pages
      url : ${{ steps.deployment.outputs.page_url }}

    permissions :
      pages : write
      contents : read
      id-token : write

    steps :
    - name : deploy static site
      uses : kiarashvosough1999/[email protected]

Обязательно предоставьте доступ к pages , contents и id-token , иначе действие не сможет отправить сайт в Github-Pages.

Обязательно укажите name и url в среде, как показано в примере, иначе задание завершится неудачно.

Интеграция со статическим сайтом Build DocC

Вы можете использовать build-docC-static-site для создания статического сайта из архива DocC.

docC-generated-static-site-uploaded-name по умолчанию, связанное с build-docC-static-site, и docC-generated-static-site-zipped-upload-name связанное с этим действием, входные данные должны быть одинаковыми.

Это действие разархивирует входной статический сайт с расширением gtar и tar . Поэтому не указывайте расширение zip ни для docC-generated-static-site-uploaded-name , ни docC-generated-static-site-zipped-upload-name .

Авторы

Не стесняйтесь делиться своими идеями или любыми другими проблемами. Запросы на вытягивание приветствуются.

Лицензия

docC-github-pages-deploy выпускается под лицензией MIT. См. ЛИЦЕНЗИЯ для получения дополнительной информации.