大佬教程收集整理的这篇文章主要介绍了利用 Github Actions 自动更新 docfx 文档,大佬教程大佬觉得挺不错的,现在分享给大家,也给大家做个参考。
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
自动更新文档 commit 示例
.git
目录包含git信息,不能删除)Actions 示例,源链接:https://github.com/WeihanLi/WeihanLi.Npoi/blob/dev/.github/workflows/docfx.yml
name: docfx build
on:
push:
branches:
- dev
jobs:
build:
name: Build
runs-on: windows-latest
steps:
# check out the branch that triggered this workflow to the 'source' subdirectory
- name: checkout Code
uses: actions/checkout@v2
with:
ref: dev
path: source
- name: install DocFX
run: "& choco install docfx -y"
# Run a build
- name: Build docs
run: "& docfx ./docfx.Json"
working-directory: ./source
# check out gh-pages branch to the 'docs' subdirectory
- name: checkout docs
uses: actions/checkout@v2
with:
ref: gh-pages
path: docs
# Sync the site
- name: Clear docs repo
run: Get-ChildItem -Force -Exclude .git | ForEach-Object { Remove-Item -Recurse -Verbose -Force $_ }
working-directory: ./docs
- name: Sync new content
run: copy-Item -Recurse -Verbose -Force "$env:GITHUB_WORKSPACE/source/_site/*" "$env:GITHUB_WORKSPACE/docs"
working-directory: ./docs
# update docs
- name: Commit to gh-pages and push
run: |
$ErrOractionPreference = "ConTinue"
git add -A
git diff head --exit-code
if ($LASTEXITCODE -eq 0) {
Write-Host "No changes to commit!"
} else {
git config --global user.name "github-actions-docfx[bot]"
git config --global user.email "weihanli@outlook.com"
git commit -m "updated docs from commit $env:GITHUB_SHA on $env:GITHUB_REF"
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
git push origin gh-pages
}
working-directory: ./docs
@H_930_67@more
现在用的还是 2.x 版本,3.x 版本还没发布,3.x版本发布之后可以直接通过 dotnet tool
来安装更加方便和可扩展,目前 2.x 使用 choco
来安装命令行工具,需要依赖 Chocolatey,如果是 dotnet tool
有 dotnet 环境就可以了,就可以方便很多了
不仅仅是 docfx 生成文档,你也可以扩展其他类似的需求,使用 Github Actions 实现自动同步,更新
以上是大佬教程为你收集整理的利用 Github Actions 自动更新 docfx 文档全部内容,希望文章能够帮你解决利用 Github Actions 自动更新 docfx 文档所遇到的程序开发问题。
如果觉得大佬教程网站内容还不错,欢迎将大佬教程推荐给程序员好友。
本图文内容来源于网友网络收集整理提供,作为学习参考使用,版权属于原作者。
如您有任何意见或建议可联系处理。小编QQ:384754419,请注明来意。