Docs & Website: Fixed build automation in CI (Fixes #1004) (#1214)

* websites/apidocs/docs.ps1: Use Set-Location to ensure dotnet tool commands are run from the repo root in CI

* websites/site/site.ps1: Use Set-Location to ensure dotnet tool commands are run in the repo root in CI

* .github/workflows (Lucene-Net-Documentation.yml + Lucene.Net.Website.yml): Updated actions tasks to the latest version

Author: NightOwl888

.github/workflows/Lucene-Net-Documentation.yml

@@ -57,7 +57,7 @@ jobs:
 
       # Checkout the main repo with all history so we get all tags
       - name: Checkout Lucene.Net source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
         with:
           path: main-repo
           fetch-depth: 0
@@ -119,12 +119,12 @@ jobs:
         shell: powershell
 
       - name: Setup .NET 6 SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: '6.0.x'
 
       - name: Setup .NET 8 SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v5
         with:
           dotnet-version: '8.0.x'
 
@@ -133,7 +133,7 @@ jobs:
         shell: powershell
 
       - name: Checkout Lucene.Net website
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
         with:
           repository: ${{ env.SITE_REPO }}
           ref: asf-site

.github/workflows/Lucene-Net-Website.yml

@@ -50,7 +50,7 @@ jobs:
 
       # Checkout the main repo with all history so we get all tags
       - name: Checkout Lucene.Net source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
         with:
           path: main-repo
           fetch-depth: 0
@@ -106,14 +106,14 @@ jobs:
         shell: powershell
 
       - name: Upload website as build artifact
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         if: ${{always()}}
         with:
           name: 'website'
           path: '${{github.workspace}}/main-repo/websites/site/_site'
 
       - name: Checkout Lucene.Net website
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
         with:
           repository: ${{ env.SITE_REPO }}
           ref: asf-site

websites/apidocs/docs.ps1

@@ -66,8 +66,12 @@ $BreadcrumbPath = Join-Path -Path $ApiDocsFolder -ChildPath "docfx.global.subsit
 Write-Host "Restoring docfx tool..."
 $PreviousLocation = Get-Location
 Set-Location $RepoRoot
-dotnet tool restore
-Set-Location $PreviousLocation
+try {
+    dotnet tool restore
+} finally {
+    Set-Location $PreviousLocation
+}
+
 
 # delete anything that already exists
 if ($Clean) {
@@ -155,7 +159,13 @@ if ($? -and $DisableMetaData -eq $false) {
 
         # build the output
         Write-Host "Building api metadata for $projFile..."
-        & dotnet tool run docfx metadata $projFile --log "$DocFxLog" --logLevel $LogLevel
+        $PreviousLocation = Get-Location
+        Set-Location $RepoRoot
+        try {
+            & dotnet tool run docfx metadata $projFile --log "$DocFxLog" --logLevel $LogLevel
+        } finally {
+            Set-Location $PreviousLocation
+        }
     }
 }
 
@@ -183,7 +193,13 @@ if ($? -and $DisableBuild -eq $false) {
 
         # build the output
         Write-Host "Building site output for $projFile..."
-        & dotnet tool run docfx build $projFile --log "$DocFxLog" --logLevel $LogLevel --debug --maxParallelism 1
+        $PreviousLocation = Get-Location
+        Set-Location $RepoRoot
+        try {
+            & dotnet tool run docfx build $projFile --log "$DocFxLog" --logLevel $LogLevel --debug --maxParallelism 1
+        } finally {
+            Set-Location $PreviousLocation
+        }
 
         # Add the baseUrl to the output xrefmap, see https://github.com/dotnet/docfx/issues/2346#issuecomment-356054027
         $projFileJson = Get-Content $projFile | ConvertFrom-Json
@@ -201,16 +217,22 @@ if ($? -and $DisableBuild -eq $false) {
 if ($?) {
     $DocFxLog = Join-Path -Path $ApiDocsFolder "obj\docfx.site.json.log"
 
-    if ($ServeDocs -eq $false) {
-
-        # build the output
-        Write-Host "Building docs..."
-        & dotnet tool run docfx $DocFxJsonSite --log "$DocFxLog" --logLevel $LogLevel --debug --maxParallelism 1
-    }
-    else {
-        # build + serve (for testing)
-        Write-Host "starting website..."
-        & dotnet tool run docfx $DocFxJsonSite --log "$DocFxLog" --logLevel $LogLevel --serve --port $StagingPort --debug --maxParallelism 1
+    $PreviousLocation = Get-Location
+    Set-Location $RepoRoot
+    try {
+        if ($ServeDocs -eq $false) {
+
+            # build the output
+            Write-Host "Building docs..."
+            & dotnet tool run docfx $DocFxJsonSite --log "$DocFxLog" --logLevel $LogLevel --debug --maxParallelism 1
+        }
+        else {
+            # build + serve (for testing)
+            Write-Host "starting website..."
+            & dotnet tool run docfx $DocFxJsonSite --log "$DocFxLog" --logLevel $LogLevel --serve --port $StagingPort --debug --maxParallelism 1
+        }
+    } finally {
+        Set-Location $PreviousLocation
     }
 }
 

websites/site/site.ps1

@@ -46,8 +46,11 @@ if ($Clean) {
 # install docfx tool
 $PreviousLocation = Get-Location
 Set-Location $RepoRoot
-dotnet tool restore
-Set-Location $PreviousLocation
+try {
+    dotnet tool restore
+} finally {
+    Set-Location $PreviousLocation
+}
 
 # delete anything that already exists
 if ($Clean) {
@@ -62,14 +65,20 @@ $DocFxJson = Join-Path -Path $SiteFolder "docfx.json"
 $DocFxLog = Join-Path -Path $SiteFolder "obj\docfx.log"
 
 if($?) {
-    if ($ServeDocs -eq $false) {
-        # build the output
-        Write-Host "Building docs..."
-        & dotnet tool run docfx build $DocFxJson -l "$DocFxLog" --logLevel $LogLevel
-    }
-    else {
-        # build + serve (for testing)
-        Write-Host "starting website..."
-        & dotnet tool run docfx $DocFxJson --serve --port $StagingPort
+    $PreviousLocation = Get-Location
+    Set-Location $RepoRoot
+    try {
+        if ($ServeDocs -eq $false) {
+            # build the output
+            Write-Host "Building docs..."
+            & dotnet tool run docfx build $DocFxJson -l "$DocFxLog" --logLevel $LogLevel
+        }
+        else {
+            # build + serve (for testing)
+            Write-Host "starting website..."
+            & dotnet tool run docfx $DocFxJson --serve --port $StagingPort
+        }
+    } finally {
+        Set-Location $PreviousLocation
     }
 }