Merge pull request #2816 from moreal/dotnet-tool-manifest

Use dotnet tool-manifest
planetarium · Sep 10, 2024 · f5f9b65 · f5f9b65
2 parents 31cbd41 + e1b7d96
commit f5f9b65
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 4 deletions.
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -0,0 +1,12 @@
+{
+  "version": 1,
+  "isRoot": true,
+  "tools": {
+    "docfx": {
+      "version": "2.77.0",
+      "commands": [
+        "docfx"
+      ]
+    }
+  }
+}
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - add-docs # This branch is temporary.
 
 jobs:
   publish-docs:
@@ -24,7 +23,7 @@ jobs:
           dotnet-version: 6.0.400
 
       - run: dotnet restore
-      - run: dotnet tool update -g docfx
+      - run: dotnet tool restore
       - run: docfx docs/docfx.json
 
       - name: deploy

diff --git a/docs/README.md b/docs/README.md
@@ -2,14 +2,23 @@
 
 The documents are published using [DocFX](https://dotnet.github.io/docfx/).
 
+## Install DocFX
+
+This project uses `tool-manifest` to specify tools' versions used in
+this project. You can install tools with the below command:
+
+```
+dotnet tool restore
+```
+
 ## Preview
 
 ```
-docfx build --serve
+dotnet docfx build --serve
 ```
 
 ## Publish
 
 ```
-docfx build
+dotnet docfx build
 ```