Update changelog download strategy in workflows

The download strategies used in "docs-changelog-generate.yaml" and "docs-stable.yaml" workflow files are updated to control the number of versions retrieved for the changelog instead of getting all or latest versions. In "Program.cs", changed the condition to accept the "VersionCount" argument and implemented a loop to fetch 'n' latest versions where 'n' is the given argument value.

Author: AndreyAkinshin

.github/workflows/docs-changelog-generate.yaml

@@ -19,7 +19,7 @@ jobs:
         ref: master
 
     - name: Download changelog
-      run: ./build.sh --target DocFX_Changelog_Download --LatestVersions true
+      run: ./build.sh --target DocFX_Changelog_Download --LatestVersions 1
       env:
         GITHUB_PRODUCT: ChangelogBuilder
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs-stable.yaml

@@ -21,12 +21,11 @@ jobs:
     - name: Build BenchmarkDotNet
       run: ./build.bat --target Build
 
-    # Temporary disabled because of the API limit
-    # - name: Download changelog
-    #   run: ./build.bat --target DocFX_Changelog_Download --LatestVersions true --StableVersions true
-    #   env:
-    #     GITHUB_PRODUCT: ChangelogBuilder
-    #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    - name: Download changelog
+      run: ./build.bat --target DocFX_Changelog_Download --LatestVersions 1
+      env:
+        GITHUB_PRODUCT: ChangelogBuilder
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
     - name: Build documentation
       run: ./build.bat --target DocFX_Build

build/Program.cs

@@ -1,3 +1,4 @@
+using System;
 using System.IO;
 using System.Linq;
 using System.Text;
@@ -469,22 +470,23 @@ public class DocFxChangelogDownloadTask : FrostingTask<BuildContext>
 {
     public override void Run(BuildContext context)
     {
-        if (context.Argument("AllVersions", false))
+        var count = context.Argument("VersionCount", -1);
+        var total = DocumentationHelper.BdnAllVersions.Length;
+        
+        if (count == 0)
         {
             context.DocfxChangelogDownload(
                 DocumentationHelper.BdnAllVersions.First(),
                 DocumentationHelper.BdnFirstCommit);
 
-            for (int i = 1; i < DocumentationHelper.BdnAllVersions.Length; i++)
+            for (int i = 1; i < total; i++)
                 context.DocfxChangelogDownload(
                     DocumentationHelper.BdnAllVersions[i],
                     DocumentationHelper.BdnAllVersions[i - 1]);
         }
-        else if (context.Argument("LatestVersions", false))
+        else if (count > 0)
         {
-            for (int i = DocumentationHelper.BdnAllVersions.Length - 3;
-                 i < DocumentationHelper.BdnAllVersions.Length;
-                 i++)
+            for (int i = Math.Max(total - count, 1); i < total; i++)
                 context.DocfxChangelogDownload(
                     DocumentationHelper.BdnAllVersions[i],
                     DocumentationHelper.BdnAllVersions[i - 1]);