File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -108,6 +108,10 @@ jobs:
108108 fi
109109
110110 MODE=$( [ "$IS_RELEASE" = "true" ] && echo "Release" || echo "CI" )
111+ REPO="${{ github.repository }}"
112+ OWNER="${REPO%%/*}"
113+ REPO_NAME="${REPO##*/}"
114+ DOCS_URL="https://${OWNER,,}.github.io/${REPO_NAME}/"
111115
112116 {
113117 echo "## Version Info"
@@ -121,6 +125,8 @@ jobs:
121125 echo "| **Bump Type** | **$BUMP** |"
122126 echo "| **Mode** | $MODE |"
123127 echo "| **Commit** | \`${SHA::8}\` |"
128+ echo "| **Expected Docs URL** | $DOCS_URL |"
129+ echo "| **Docs Auto-Deploy** | Enable Pages (GitHub Actions) + add \`docs/docfx.json\` |"
124130 } >> "$GITHUB_STEP_SUMMARY"
125131
126132 - name : Compute build matrix
Original file line number Diff line number Diff line change @@ -151,6 +151,9 @@ To enable automatic documentation deployment to GitHub Pages:
1511511. Add a `docs/docfx.json` configuration file
1521522. Enable GitHub Pages in **Settings > Pages > Source : GitHub Actions**
1531533. The `deploy-docs` job will automatically build and deploy after each release
154+ 4. Expected docs URL : ` https://<owner>.github.io/<repo>/` (for this repo: `https://agibuild.github.io/dotnet.CI.template/`)
155+
156+ The `Resolve Version` job summary always shows this expected docs URL, even when docs deployment is skipped.
154157
155158---
156159
Original file line number Diff line number Diff line change @@ -90,6 +90,8 @@ push / PR to main + weekly
9090如果使用 DocFX 文档部署:
9191- Settings → Pages → Source 选择 GitHub Actions
9292- environment ` github-pages ` 会自动创建
93+ - 预期文档地址:` https://<owner>.github.io/<repo>/ ` (本仓库为 ` https://agibuild.github.io/dotnet.CI.template/ ` )
94+ - ` Resolve Version ` 的 Summary 会固定显示该地址,便于快速访问
9395
9496### Secrets
9597- ` NUGET_API_KEY ` :NuGet.org API key(在 repo 或 ` release ` environment 级别配置)
Original file line number Diff line number Diff line change @@ -45,6 +45,7 @@ resolve-version → build-and-test (matrix) → release (需 approve) → deploy
4545- 一个新的 GitHub Release
4646- Release 附件里有各平台安装包 zip(` app-linux-x64.zip ` 、` app-win-x64.zip ` 等)
4747- NuGet.org 上有对应版本的包(如已配置 ` NUGET_API_KEY ` )
48+ - 如果已启用 Pages + DocFX:文档地址 ` https://agibuild.github.io/dotnet.CI.template/ `
4849
4950---
5051
You can’t perform that action at this time.
0 commit comments