Add support to download a specific version of the AzureDevOps.WikiPDFExport CLI tools (#2167)

* Add option to download specific version of CLI tool
* NPM Package Update

Author: rfennell

Extensions/WikiPDFExport/WikiPDFExportTask/WikiPDFExportTaskV4/package-lock.json

@@ -14,8 +14,8 @@
   },
   "main": "test.js",
   "dependencies": {
+    "axios": "^1.13.2",
     "azure-pipelines-task-lib": "^4.10.1",
-    "download-github-release": "^0.3.2",
     "fs": "0.0.1-security",
     "ncp": "^2.0.0",
     "process": "^0.11.10",

Extensions/WikiPDFExport/WikiPDFExportTask/WikiPDFExportTaskV4/package.json

@@ -2,6 +2,7 @@ import * as process from "process";
 import { exec } from "child_process";
 import * as fs from "fs";
 import * as path from "path";
+import axios from "axios";
 import {
     CloneWikiRepo,
     GetTrimmedUrl,
@@ -16,35 +17,59 @@ import {
 import { filePathSupplied } from "azure-pipelines-task-lib";
 
 async function DownloadGitHubArtifact(
-    user,
+    owner,
     repo,
     folder,
-    usePreRelease,
+    desiredVersion,
     artifactName,
     logInfo,
     logError) {
 
-    var downloadRelease = require("download-github-release");
-    logInfo(`Starting download ${artifactName} to ${folder}`);
-    await downloadRelease(
-        user,
-        repo,
-        folder,
-        function filterRelease(release) {
-            // Filter out prereleases.
-            return release.prerelease === usePreRelease;
-        },
-        function filterAsset(asset) {
-            // Select assets that contain the string .
-            return (asset.name === artifactName);
-        },
-        false)
-    .then(function() {
-        logInfo("Download done");
-    })
-    .catch(function(err) {
-        logError(err.message);
+ try {
+    const apiUrl = desiredVersion
+      ? `https://api.github.com/repos/${owner}/${repo}/releases/tags/${desiredVersion}`
+      : `https://api.github.com/repos/${owner}/${repo}/releases/latest`;
+
+    logInfo(`Fetching release from: ${apiUrl}`);
+    // Get release info
+    const response = await axios.get(apiUrl, {
+      headers: {
+        "User-Agent": "github-release-downloader",
+      },
+    });
+    const release = response.data;
+
+    // Locate the asset
+    const asset = release.assets.find((a) => a.name === artifactName);
+    if (!asset) {
+      logError(`Asset "${artifactName}" not found in release ${release.tag_name}.`);
+      return;
+    }
+
+    // Download the asset
+    const downloadResponse = await axios.get(asset.browser_download_url, {
+      responseType: "stream", // Required for downloading binary files
+    });
+
+    // Stream the asset to a file
+    if (!fs.existsSync(folder)) {
+      logInfo(`Creating folder: ${folder}`);
+      fs.mkdirSync(folder, { recursive: true });
+    }
+    const filePath = path.join(folder, artifactName);
+    const writer = fs.createWriteStream(filePath);
+    downloadResponse.data.pipe(writer);
+
+    writer.on("finish", () => {
+      logInfo(`Downloaded file at: ${filePath}`);
+    });
+
+    writer.on("error", (err) => {
+      logError("Error writing file:", err);
     });
+  } catch (error) {
+    logError("Error downloading release:", error.response ? error.response.data : error.message);
+  }
 }
 
 export async function ExportPDF(
@@ -138,7 +163,7 @@ export async function ExportPDF(
 export async function GetExePath (
     overrideExePath,
     workingFolder,
-    usePreRelease,
+    desiredVersion,
     os: string
 ) {
     if (overrideExePath &&  overrideExePath.length > 0) {
@@ -161,7 +186,7 @@ export async function GetExePath (
             "MaxMelcher",
             "AzureDevOps.WikiPDFExport",
             workingFolder,
-            usePreRelease,
+            desiredVersion,
             artifactName,
             logInfo,
             logError);

Extensions/WikiPDFExport/WikiPDFExportTask/WikiPDFExportTaskV4/src/ExportFunctions.ts

@@ -27,6 +27,7 @@ var cloneRepo = tl.getBoolInput("cloneRepo");
 var overrideExePath = tl.getInput("overrideExePath");
 var workingFolder = tl.getInput("downloadPath");
 var rootExportPath = tl.getInput("rootExportPath");
+var desiredVersion = tl.getInput("desiredVersion");
 var usePreRelease = tl.getBoolInput("usePreRelease");
 
 // make sure that we support older configs where these two parameter were a single setting
@@ -46,15 +47,20 @@ console.log(`Variable: OutputFile [${outputFile}]`);
 console.log(`Variable: Branch [${branch}]`);
 console.log(`Variable: InjectExtraHeader [${injectExtraHeader}]`);
 console.log(`Variable: OverrideExePath [${overrideExePath}]`);
-console.log(`Variable: UsePreRelease [${usePreRelease}]`);
+console.log(`Variable: DesiredVersion [${desiredVersion}]`);
 console.log(`Variable: DownloadPath [${workingFolder}]`);
+console.log(`Variable: UsePreRelease [${usePreRelease}]`);
+
+if (usePreRelease === true) {
+    logWarning(`The usePreRelease option is no longer used, it has been replaced by desiredVersion.`);
+}
 
 var os = tl.getVariable("AGENT.OS");
 
 GetExePath(
     overrideExePath,
     workingFolder,
-    usePreRelease,
+    desiredVersion,
     os
 ).then((exePath) => {
     if (exePath.length > 0) {

Extensions/WikiPDFExport/WikiPDFExportTask/WikiPDFExportTaskV4/src/WikiPDFExportTask.ts

@@ -153,10 +153,19 @@
     {
       "name": "usePreRelease",
       "type": "boolean",
-      "label": "Use pre-release versions of the export tool",
+      "label": "Use pre-release versions of the export tool (deprecated)",
       "defaultValue": "False",
       "required": false,
-      "helpMarkDown": "If set to true pre-release version of the [AzureDevOps.WikiPDFExport tool](https://github.com/MaxMelcher/AzureDevOps.WikiPDFExport) tool will be used",
+      "helpMarkDown": "The usePreRelease option is no longer used, it has been replaced by desiredVersion.",
+      "groupName": "advanced"
+    },
+    {
+      "name": "desiredVersion",
+      "type": "string",
+      "label": "Use specific versions of the export tool",
+      "defaultValue": "",
+      "required": false,
+      "helpMarkDown": "Set to a release tag, if not set latest will use version of the [AzureDevOps.WikiPDFExport tool](https://github.com/MaxMelcher/AzureDevOps.WikiPDFExport) tool will be used",
       "groupName": "advanced"
     }
   ],

Extensions/WikiPDFExport/WikiPDFExportTask/WikiPDFExportTaskV4/task/task.json

@@ -6,32 +6,32 @@ import * as fse from "fs-extra";
 
 describe("Get Exe Path ", () => {
   it("should be able download the pre release", async () => {
-    var actual = await GetExePath("", "./testdata", true, "Windows_NT");
+    var actual = await GetExePath("", "./testdata", "4.6.0", "Windows_NT");
     expect(actual).to.equal(`testdata\\azuredevops-export-wiki.exe`);
   }).timeout(20000);     // the default is 2000ms and that is too fast or the download
 
   it("should be able download the latest production windows release", async () => {
-    var actual = await GetExePath("", "./testdata", false, "Windows_NT");
+    var actual = await GetExePath("", "./testdata", "", "Windows_NT");
     expect(actual).to.equal(`testdata\\azuredevops-export-wiki.exe`);
   }).timeout(20000);     // the default is 2000ms and that is too fast or the download
 
   it("should be able download the latest production Linux release", async () => {
-    var actual = await GetExePath("", "./testdata", false, "Linux");
+    var actual = await GetExePath("", "./testdata", "", "Linux");
     expect(actual).to.equal(`testdata\\azuredevops-export-wiki`);
   }).timeout(20000);     // the default is 2000ms and that is too fast or the download
 
   it("should be able download the latest production MacOS release", async () => {
-    var actual = await GetExePath("", "./testdata", false, "Darwin");
+    var actual = await GetExePath("", "./testdata", "", "Darwin");
     expect(actual).to.equal(`testdata\\azuredevops-export-wiki-osx`);
   }).timeout(20000);     // the default is 2000ms and that is too fast or the download
 
-  it("should be able to override the release download", async () => {
-    var actual = await GetExePath(".\\testdata\\dummy.exe.txt", "", true, "Windows_NT");
+  it("should be able to override the latest release download", async () => {
+    var actual = await GetExePath(".\\testdata\\dummy.exe.txt", "", "", "Windows_NT");
     expect(actual).to.equal(`.\\testdata\\dummy.exe.txt`);
   });
 
-  it("should be able to override the release download", async () => {
-    var actual = await GetExePath(".\\testdata\\dummy.exe.txt", "", true, "Windows_NT");
+  it("should be able to override the desired release download", async () => {
+    var actual = await GetExePath(".\\testdata\\dummy.exe.txt", "", "4.6.0", "Windows_NT");
     expect(actual).to.equal(`.\\testdata\\dummy.exe.txt`);
   });
 

Extensions/WikiPDFExport/WikiPDFExportTask/WikiPDFExportTaskV4/test/getExe.test.ts

@@ -142,6 +142,9 @@ stages:
           deploy:
             steps:
             - template: test-stage.yml
+              parameters:
+                dotnetVersion: '6.0.x'
+                desiredVersion: '4.6.0'
     - deployment: Private_Tests_Mac
       timeoutInMinutes: 0
       environment: 'Azure DevOps Marketplace (WIKIPDFExport)'

Extensions/WikiPDFExport/azure-pipelines-build.yml

@@ -2,6 +2,12 @@ parameters:
 - name: localpath
   type: string
   default: $(Agent.TempDirectory) 
+- name: dotnetVersion
+  type: string
+  default: '8.0.x'
+- name: desiredVersion
+  type: string
+  default: ''
 
 steps:
 - checkout: VSTSBuildTaskValidation
@@ -13,7 +19,7 @@ steps:
   displayName: 'Use .NET Core runtime'
   inputs:
     packageType: 'runtime'
-    version: '6.0.x'
+    version: '${{parameters.dotnetVersion}}'
     includePreviewVersions: false
 - task: richardfennellBM.BM-VSTS-XplatGenerateReleaseNotes-DEV1.XplatGenerate-Release-Notes.XplatGenerateReleaseNotes@4
   displayName: 'Generate Release Notes based on Release Comparision API'
@@ -42,13 +48,16 @@ steps:
       {{/forEach}}
 - task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks-DEV.WikiPDFExportTask.WikiPdfExportTask@3
   displayName: 'Export Single File'
+  enabled: false
   inputs:
     cloneRepo: false
     usePreRelease: false
     localpath: '$(System.DefaultWorkingDirectory)'
     singleFile: 'inline.md'
     outputFile: '$(Build.ArtifactStagingDirectory)/PDF/$(Agent.OS)-singleFileV3.pdf'
     downloadPath: '${{parameters.localpath}}'
+
+
 - task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks-DEV.WikiPDFExportTask.WikiPdfExportTask@4
   displayName: 'Export Single File'
   inputs:
@@ -58,6 +67,8 @@ steps:
     singleFile: 'inline.md'
     outputFile: '$(Build.ArtifactStagingDirectory)/PDF/$(Agent.OS)-singleFile.pdf'
     downloadPath: '${{parameters.localpath}}'
+    desiredVersion: '${{parameters.desiredVersion}}'
+
 - task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks-DEV.WikiPDFExportTask.WikiPdfExportTask@4
   displayName: 'Export Single File'
   inputs:
@@ -67,6 +78,8 @@ steps:
     singleFile: 'inline.md'
     outputFile: '$(Build.ArtifactStagingDirectory)/PDF/$(Agent.OS)-singleFile.pdf'
     downloadPath: '${{parameters.localpath}}'
+    desiredVersion: '${{parameters.desiredVersion}}'
+
 - task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks-DEV.WikiPDFExportTask.WikiPdfExportTask@4
   displayName: 'Export Public GitHub WIKI'
   condition: succeededOrFailed()
@@ -77,6 +90,8 @@ steps:
     localpath: '$(System.DefaultWorkingDirectory)/GitHubRepo'
     outputFile: '$(Build.ArtifactStagingDirectory)/PDF/$(Agent.OS)-publicGitHub.pdf'
     downloadPath: '${{parameters.localpath}}'
+    desiredVersion: '${{parameters.desiredVersion}}'
+
 - task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks-DEV.WikiPDFExportTask.WikiPdfExportTask@4
   displayName: 'Export Azure DevOps WIKI'
   condition: succeededOrFailed()
@@ -86,6 +101,8 @@ steps:
     useAgentToken: true
     outputFile: '$(Build.ArtifactStagingDirectory)/PDF/$(Agent.OS)-Azrepo.pdf'
     downloadPath: '${{parameters.localpath}}'
+    desiredVersion: '${{parameters.desiredVersion}}'
+
 - task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks-DEV.WikiPDFExportTask.WikiPdfExportTask@4
   displayName: 'Export part of the Azure DevOps WIKI'
   condition: succeededOrFailed()
@@ -97,6 +114,8 @@ steps:
     localpath: '$(System.DefaultWorkingDirectory)/repopartial'
     rootExportPath: '$(System.DefaultWorkingDirectory)/repopartial/folder'
     downloadPath: '${{parameters.localpath}}'
+    desiredVersion: '${{parameters.desiredVersion}}'
+
 - task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks-DEV.WikiPDFExportTask.WikiPdfExportTask@4
   displayName: 'Export single part of the Azure DevOps WIKI'
   condition: succeededOrFailed()
@@ -109,6 +128,8 @@ steps:
     rootExportPath: '$(System.DefaultWorkingDirectory)/repopartial1/folder'
     downloadPath: '${{parameters.localpath}}'
     singlefile: 'test1.md'
+    desiredVersion: '${{parameters.desiredVersion}}'
+
 - task: richardfennellBM.BM-VSTS-WikiPDFExport-Tasks-DEV.WikiPDFExportTask.WikiPdfExportTask@4
   displayName: 'Export Azure DevOps WIKI without downloading tool'
   condition: and(succeededOrFailed(), eq(variables['AGENT.OS'], 'Windows_NT'))
@@ -119,6 +140,8 @@ steps:
     useAgentToken: true
     outputFile: '$(Build.ArtifactStagingDirectory)/PDF/$(Agent.OS)-Azrepo-nodownload.pdf'
     downloadPath: '${{parameters.localpath}}'
+    desiredVersion: '${{parameters.desiredVersion}}'
+
 - task: PublishPipelineArtifact@0
   condition: succeededOrFailed()
   inputs: