docC github pages deploy

DocC Github Pages 部署：将生成的 DocC 静态站点部署到 Github-Pages。

• 要求
• 用法
• 一体化
• 贡献者
• 执照

要求

平台	地位
ubuntu-最新版	已测试

用法

请参阅操作.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 ，否则作业将失败。

与构建 DocC 静态站点集成

您可以使用 build-docC-static-site 从 DocC Archive 生成​​静态站点。

与 build-docC-static-site 关联的默认docC-generated-static-site-uploaded-name和与此操作关联的docC-generated-static-site-zipped-upload-name ，输入必须相同。

此操作将使用gtar和tar扩展名解压缩输入静态站点。因此，请勿在docC-generated-static-site-uploaded-name或docC-generated-static-site-zipped-upload-name上指定 zip 扩展名。

贡献者

请随意分享您的想法或任何其他问题。欢迎请求请求。

执照

docC-github-pages-deploy 是根据 MIT 许可证发布的。请参阅许可证了解更多信息。