免费资源部落

本篇文章给大家分享的是有关如何利用Github Actions自动更新docfx文档，小编觉得挺实用的，因此分享给大家学习，希望大家阅读完这篇文章后可以有所收获，话不多说，跟着小编一起来看看吧。

利用 Github Actions 自动更新 docfx 文档Intro

docfx 是微软出品一个 .NET API 文档框架，有一个理念是代码即文档，会根据项目代码自动生成 API 文档，即使没有写任何注释也会生成 API 文档，也有一些默认的主题可以配置，也可以自定义主题配置，详细介绍可以参考官方介绍 https://dotnet.github.io/docfx/

目前也有很多项目在使用 docfx 来生成文档，比如前段时间介绍过的 Reserver-Proxy 项目，也是看到了 reservse-proxy 项目配置了一个 Github Actions 来自动更新文档所以在我自己的项目里也增加了类似的配置，除了微软的项目还有很多社区开源项目在用，如果你也在做一些 .NET 类库类的开源项目，可以尝试一下

docfx 怎么使用可以参考官方文档，本文主要介绍如何使用 Github Actions 实现自动更新文档

文档示例

更多可以参考: https://weihanli.github.io/WeihanLi.Npoi/index.html

自动更新文档流程检出要使用的用于生成文档的分支代码安装 docfx 命令行工具，推荐使用 choco 安装，因为执行 build 的 agent 上已经安装了 Chocolatey使用 docfx 生成文档检出 gh-pages 分支，用于托管文档的分支删除 gh-pages 之前的文件（ .git目录包含git信息，不能删除）把第三步操作生成的文档复制到 gh-pages 分支下commit && push，提交代码并推送更新在线文档Github Actions 示例配置

Actions 示例，源链接:https://github.com/WeihanLi/WeihanLi.Npoi/blob/dev/.github/workflows/docfx.yml

name:docfxbuildon:push:branches:-devjobs:build:name:Buildruns-on:windows-lateststeps:#Checkoutthebranchthattriggeredthisworkflowtothe'source'subdirectory-name:CheckoutCodeuses:actions/checkout@v2with:ref:devpath:source-name:installDocFXrun:"&chocoinstalldocfx-y"#Runabuild-name:Builddocsrun:"&docfx./docfx.json"working-directory:./source#Checkoutgh-pagesbranchtothe'docs'subdirectory-name:Checkoutdocsuses:actions/checkout@v2with:ref:gh-pagespath:docs#Syncthesite-name:Cleardocsreporun:Get-ChildItem-Force-Exclude.git|ForEach-Object{Remove-Item-Recurse-Verbose-Force$_}working-directory:./docs-name:Syncnewcontentrun:Copy-Item-Recurse-Verbose-Force"$env:GITHUB_WORKSPACE/source/_site/*">working-directory:./docs#updatedocs-name:Committogh-pagesandpushrun:|$ErrorActionPreference="Continue"gitadd-AgitdiffHEAD--exit-codeif($LASTEXITCODE-eq0){Write-Host"Nochangestocommit!"}else{gitconfig--globaluser.name"github-actions-docfx[bot]"gitconfig--globaluser.email"weihanli@outlook.com"gitcommit-m"Updateddocsfromcommit$env:GITHUB_SHAon$env:GITHUB_REF"gitremoteset-urloriginhttps://x-access-token:${{secrets.GITHUB_TOKEN}}@github.com/${{github.repository}}gitpushorigingh-pages}working-directory:./docs我这里是只要 dev 分支更新了就更新，你也可以根据需要当 master 分支更新时再更新，修改分支名称即可

现在用的还是 2.x 版本，3.x 版本还没发布，3.x版本发布之后可以直接通过 dotnet tool 来安装更加方便和可扩展，目前 2.x 使用 choco 来安装命令行工具，需要依赖 Chocolatey，如果是 dotnet tool 有 dotnet 环境就可以了，就可以方便很多了

不仅仅是 docfx 生成文档，你也可以扩展其他类似的需求，使用 Github Actions 实现自动同步，更新。

以上就是如何利用Github Actions自动更新docfx文档，小编相信有部分知识点可能是我们日常工作会见到或用到的。希望你能通过这篇文章学到更多知识。更多详情敬请关注行业资讯频道。