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

如何利用GithubActions自動(dòng)更新docfx文檔

本篇文章給大家分享的是有關(guān)如何利用Github Actions自動(dòng)更新docfx文檔,小編覺(jué)得挺實(shí)用的,因此分享給大家學(xué)習(xí),希望大家閱讀完這篇文章后可以有所收獲,話不多說(shuō),跟著小編一起來(lái)看看吧。

成都創(chuàng)新互聯(lián)公司堅(jiān)信:善待客戶,將會(huì)成為終身客戶。我們能堅(jiān)持多年,是因?yàn)槲覀円恢笨芍档眯刨嚒N覀儚牟缓鲇瞥踉L客戶,我們用心做好本職工作,不忘初心,方得始終。十多年網(wǎng)站建設(shè)經(jīng)驗(yàn)成都創(chuàng)新互聯(lián)公司是成都老牌網(wǎng)站營(yíng)銷服務(wù)商,為您提供網(wǎng)站制作、做網(wǎng)站、網(wǎng)站設(shè)計(jì)、H5技術(shù)、網(wǎng)站制作、品牌網(wǎng)站設(shè)計(jì)、微信平臺(tái)小程序開(kāi)發(fā)服務(wù),給眾多知名企業(yè)提供過(guò)好品質(zhì)的建站服務(wù)。

利用 Github Actions 自動(dòng)更新 docfx 文檔

Intro

docfx 是微軟出品一個(gè) .NET API 文檔框架,有一個(gè)理念是代碼即文檔,會(huì)根據(jù)項(xiàng)目代碼自動(dòng)生成 API 文檔,即使沒(méi)有寫任何注釋也會(huì)生成 API 文檔,也有一些默認(rèn)的主題可以配置,也可以自定義主題配置,詳細(xì)介紹可以參考官方介紹 https://dotnet.github.io/docfx/

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

docfx 怎么使用可以參考官方文檔,本文主要介紹如何使用 Github Actions 實(shí)現(xiàn)自動(dòng)更新文檔

 

文檔示例

如何利用Github Actions自動(dòng)更新docfx文檔  
如何利用Github Actions自動(dòng)更新docfx文檔  

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

 

自動(dòng)更新文檔流程

  1. 檢出要使用的用于生成文檔的分支代碼
  2. 安裝 docfx 命令行工具,推薦使用 choco 安裝,因?yàn)閳?zhí)行 build 的 agent 上已經(jīng)安裝了 Chocolatey
  3. 使用 docfx 生成文檔
  4. 檢出 gh-pages 分支,用于托管文檔的分支
  5. 刪除 gh-pages 之前的文件(     .git目錄包含git信息,不能刪除)
  6. 把第三步操作生成的文檔復(fù)制到 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 分支更新了就更新,你也可以根據(jù)需要當(dāng) master 分支更新時(shí)再更新,修改分支名稱即可

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

不僅僅是 docfx 生成文檔,你也可以擴(kuò)展其他類似的需求,使用 Github Actions 實(shí)現(xiàn)自動(dòng)同步,更新。

以上就是如何利用Github Actions自動(dòng)更新docfx文檔,小編相信有部分知識(shí)點(diǎn)可能是我們?nèi)粘9ぷ鲿?huì)見(jiàn)到或用到的。希望你能通過(guò)這篇文章學(xué)到更多知識(shí)。更多詳情敬請(qǐng)關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。

當(dāng)前標(biāo)題:如何利用GithubActions自動(dòng)更新docfx文檔
標(biāo)題URL:http://chinadenli.net/article34/ihocpe.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián),為您提供虛擬主機(jī)全網(wǎng)營(yíng)銷推廣微信小程序網(wǎng)站改版App設(shè)計(jì)響應(yīng)式網(wǎng)站

廣告

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

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