Update docfx to install a specific version (#35)

Author: markphip

src/docfx/NOTES.md

@@ -1,6 +1,6 @@
-This feature currently only supports installing the latest published version
-of DocFX. If support for older versions are required please file an Issue or
-send a pull request.
+This feature installs the latest version compatible with Microsoft's internal documentation
+platform which is currently 2.67.5. You can install a different version or 'latest" by using
+the 'version' option.
 
 ## OS Support
 

src/docfx/devcontainer-feature.json

@@ -1,8 +1,19 @@
 {
   "name": "DocFX",
   "id": "docfx",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "description": "Installs docfx tools",
+  "options": {
+    "version": {
+        "type": "string",
+        "proposals": [
+            "latest",
+            "2.67.5"
+        ],
+        "default": "2.67.5",
+        "description": "Select version of DocFX"
+    }
+  },  
   "customizations": {
     "vscode": {
       "extensions": [

src/docfx/install.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+DOCFX_VERSION=${VERSION:-"2.67.5"} 
+
 if command -v tdnf >/dev/null 2>&1; then
     tdnf update
     tdnf install -y dotnet-sdk-6.0 sudo awk ca-certificates
@@ -22,9 +24,18 @@ fi
 
 if command -v sudo >/dev/null 2>&1; then
     if [ "root" != "$_REMOTE_USER" ]; then
-        sudo -u ${_REMOTE_USER} bash -c "cd ~ && dotnet tool install --global docfx"
-        exit 0
+        if [ "latest" == "${DOCFX_VERSION}"]; then
+            sudo -u ${_REMOTE_USER} bash -c "cd ~ && dotnet tool install --global docfx"
+            exit 0
+        else
+            sudo -u ${_REMOTE_USER} bash -c "cd ~ && dotnet tool install --global docfx --version ${DOCFX_VERSION}"
+            exit 0
+        fi
     fi
 fi
 
-dotnet tool install --global docfx
+if [ "latest" == "${DOCFX_VERSION}"]; then
+    dotnet tool install --global docfx
+else
+    dotnet tool install --global docfx --version ${DOCFX_VERSION}
+fi

test/_global/mariner_tests.sh

@@ -11,6 +11,7 @@ check "no-dirs"  grep -v "drwxr" <(ls -l /tmp/mariner_tests)
 check "git-config" grep "ado-auth-helper" <(cat /tmp/mariner_tests/.git/config)
 check "dotnet" grep "pkgs.dev.azure.com" <(cat /usr/local/bin/run-dotnet.sh)
 check "nuget" grep "pkgs.dev.azure.com" <(cat /usr/local/bin/run-nuget.sh)
+check "docfx-version" bash -c "docfx --version"
 
 # Report result
 # If any of the checks above exited with a non-zero exit code, the test will fail.

test/_global/scenarios.json

@@ -54,7 +54,8 @@
                 "options": "--single-branch --no-src",
                 "scalar": "true"
             },
-            "artifacts-helper": {}
+            "artifacts-helper": {},
+            "docfx": {"version": "latest"}
         },
         "remoteEnv": {
             "EXT_GIT_PAT": "dummypat"

test/docfx/test.sh

@@ -6,7 +6,7 @@ set -e
 source dev-container-features-test-lib
 
 # Feature-specific tests
-check "version" docfx --version
+check "version" bash -c "docfx --version | grep '2.67.5'"
 
 # Report results
 # If any of the checks above exited with a non-zero exit code, the test will fail.