欧美一区二区三区老妇人-欧美做爰猛烈大尺度电-99久久夜色精品国产亚洲a-亚洲福利视频一区二区

如何利用GithubActions自動更新docfx文檔

本篇文章給大家分享的是有關如何利用Github Actions自動更新docfx文檔,小編覺得挺實用的,因此分享給大家學習,希望大家閱讀完這篇文章后可以有所收獲,話不多說,跟著小編一起來看看吧。

成都創(chuàng)新互聯公司堅信:善待客戶,將會成為終身客戶。我們能堅持多年,是因為我們一直可值得信賴。我們從不忽悠初訪客戶,我們用心做好本職工作,不忘初心,方得始終。十多年網站建設經驗成都創(chuàng)新互聯公司是成都老牌網站營銷服務商,為您提供網站制作、做網站、網站設計、H5技術、網站制作、品牌網站設計、微信平臺小程序開發(fā)服務,給眾多知名企業(yè)提供過好品質的建站服務。

利用 Github Actions 自動更新 docfx 文檔

Intro

docfx 是微軟出品一個 .NET API 文檔框架,有一個理念是代碼即文檔,會根據項目代碼自動生成 API 文檔,即使沒有寫任何注釋也會生成 API 文檔,也有一些默認的主題可以配置,也可以自定義主題配置,詳細介紹可以參考官方介紹 https://dotnet.github.io/docfx/

目前也有很多項目在使用 docfx 來生成文檔,比如前段時間介紹過的 Reserver-Proxy 項目,也是看到了 reservse-proxy 項目配置了一個 Github Actions 來自動更新文檔所以在我自己的項目里也增加了類似的配置,除了微軟的項目還有很多社區(qū)開源項目在用,如果你也在做一些 .NET 類庫類的開源項目,可以嘗試一下

docfx 怎么使用可以參考官方文檔,本文主要介紹如何使用 Github Actions 實現自動更新文檔

 

文檔示例

如何利用Github Actions自動更新docfx文檔  
如何利用Github Actions自動更新docfx文檔  

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

 

自動更新文檔流程

  1. 檢出要使用的用于生成文檔的分支代碼
  2. 安裝 docfx 命令行工具,推薦使用 choco 安裝,因為執(zhí)行 build 的 agent 上已經安裝了 Chocolatey
  3. 使用 docfx 生成文檔
  4. 檢出 gh-pages 分支,用于托管文檔的分支
  5. 刪除 gh-pages 之前的文件(     .git目錄包含git信息,不能刪除)
  6. 把第三步操作生成的文檔復制到 gh-pages 分支下
  7. commit && push,提交代碼并推送更新在線文檔
 

Github Actions 示例配置

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

name: docfx buildon:  push:    branches:      - devjobs:  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/*">        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
我這里是只要 dev 分支更新了就更新,你也可以根據需要當 master 分支更新時再更新,修改分支名稱即可

現在用的還是 2.x 版本,3.x 版本還沒發(fā)布,3.x版本發(fā)布之后可以直接通過 dotnet tool 來安裝更加方便和可擴展,目前 2.x 使用 choco 來安裝命令行工具,需要依賴 Chocolatey,如果是 dotnet tool 有 dotnet 環(huán)境就可以了,就可以方便很多了

不僅僅是 docfx 生成文檔,你也可以擴展其他類似的需求,使用 Github Actions 實現自動同步,更新。

以上就是如何利用Github Actions自動更新docfx文檔,小編相信有部分知識點可能是我們日常工作會見到或用到的。希望你能通過這篇文章學到更多知識。更多詳情敬請關注創(chuàng)新互聯行業(yè)資訊頻道。

當前標題:如何利用GithubActions自動更新docfx文檔
標題URL:http://www.chinadenli.net/article34/ihocpe.html

成都網站建設公司_創(chuàng)新互聯,為您提供虛擬主機全網營銷推廣微信小程序網站改版App設計響應式網站

廣告

聲明:本網站發(fā)布的內容(圖片、視頻和文字)以用戶投稿、用戶轉載內容為主,如果涉及侵權請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網站立場,如需處理請聯系客服。電話:028-86922220;郵箱:631063699@qq.com。內容未經允許不得轉載,或轉載時需注明來源: 創(chuàng)新互聯

成都seo排名網站優(yōu)化