Cleanup and improve scripts

Author: bkoelman

.github/workflows/build.yml

@@ -23,6 +23,7 @@ concurrency:
 env:
   DOTNET_NOLOGO: true
   DOTNET_CLI_TELEMETRY_OPTOUT: true
+  SOLUTION_FILE: JsonApiDotNetCore.sln
 
 jobs:
   build-and-test:
@@ -124,12 +125,11 @@ jobs:
         # This contains the git tag name on release; in that case, we build the docs without publishing them.
         DOCFX_SOURCE_BRANCH_NAME: ${{ github.base_ref || github.ref_name }}
       run: |
+        $ErrorActionPreference = "Stop"
+        $PSNativeCommandUseErrorActionPreference = $true
         cd docs
         & ./generate-examples.ps1
         dotnet docfx docfx.json --warningsAsErrors true
-        if ($LastExitCode -ne 0) {
-            Write-Error "docfx failed with exit code $LastExitCode."
-        }
         Copy-Item CNAME _site/CNAME
         Copy-Item home/*.html _site/
         Copy-Item home/*.ico _site/
@@ -171,7 +171,7 @@ jobs:
         $inspectCodeOutputPath = Join-Path $env:RUNNER_TEMP 'jetbrains-inspectcode-results.xml'
         Write-Output "INSPECT_CODE_OUTPUT_PATH=$inspectCodeOutputPath" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
         dotnet jb inspectcode --version
-        dotnet jb inspectcode JsonApiDotNetCore.sln --build --dotnetcoresdk=$(dotnet --version) --output="$inspectCodeOutputPath" --format="xml" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --properties:ContinuousIntegrationBuild=false --properties:RunAnalyzers=false --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=GlobalPerProduct -dsl=SolutionPersonal -dsl=ProjectPersonal
+        dotnet jb inspectcode $env:SOLUTION_FILE --build --dotnetcoresdk=$(dotnet --version) --output="$inspectCodeOutputPath" --format="xml" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --properties:ContinuousIntegrationBuild=false --properties:RunAnalyzers=false --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=GlobalPerProduct -dsl=SolutionPersonal -dsl=ProjectPersonal
     - name: Upload output to artifacts
       uses: actions/upload-artifact@v4
       with:
@@ -241,14 +241,14 @@ jobs:
 
         Write-Output "Running code cleanup on commit range $baseCommitHash..$headCommitHash in pull request."
         dotnet jb cleanupcode --version
-        dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --max-runs=5 --jb --dotnetcoresdk=$(dotnet --version) --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --properties:RunAnalyzers=false --jb --verbosity=WARN -f commits -a $headCommitHash -b $baseCommitHash --fail-on-diff --print-diff
+        dotnet regitlint -s $env:SOLUTION_FILE --print-command --skip-tool-check --max-runs=5 --jb --dotnetcoresdk=$(dotnet --version) --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --properties:RunAnalyzers=false --jb --verbosity=WARN -f commits -a $headCommitHash -b $baseCommitHash --fail-on-diff --print-diff
     - name: CleanupCode (on branch)
       if: ${{ github.event_name == 'push' || github.event_name == 'release' || github.event_name == 'workflow_dispatch' }}
       shell: pwsh
       run: |
         Write-Output 'Running code cleanup on all files.'
         dotnet jb cleanupcode --version
-        dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --jb --dotnetcoresdk=$(dotnet --version) --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --properties:RunAnalyzers=false --jb --verbosity=WARN --fail-on-diff --print-diff
+        dotnet regitlint -s $env:SOLUTION_FILE --print-command --skip-tool-check --jb --dotnetcoresdk=$(dotnet --version) --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --properties:RunAnalyzers=false --jb --verbosity=WARN --fail-on-diff --print-diff
 
   publish:
     timeout-minutes: 60

Build.ps1

@@ -1,8 +1,6 @@
-function VerifySuccessExitCode {
-    if ($LastExitCode -ne 0) {
-        throw "Command failed with exit code $LastExitCode."
-    }
-}
+#Requires -Version 7.4
+$ErrorActionPreference = "Stop"
+$PSNativeCommandUseErrorActionPreference = $true
 
 Write-Host "$(pwsh --version)"
 Write-Host ".NET SDK $(dotnet --version)"
@@ -11,16 +9,7 @@ Remove-Item -Recurse -Force artifacts -ErrorAction SilentlyContinue
 Remove-Item -Recurse -Force * -Include coverage.cobertura.xml
 
 dotnet tool restore
-VerifySuccessExitCode
-
 dotnet build --configuration Release
-VerifySuccessExitCode
-
 dotnet test --no-build --configuration Release --verbosity quiet --collect:"XPlat Code Coverage"
-VerifySuccessExitCode
-
 dotnet reportgenerator -reports:**\coverage.cobertura.xml -targetdir:artifacts\coverage -filefilters:-*.g.cs
-VerifySuccessExitCode
-
 dotnet pack --no-build --configuration Release --output artifacts/packages
-VerifySuccessExitCode

cleanupcode.ps1

@@ -1,4 +1,4 @@
-#Requires -Version 7.0
+#Requires -Version 7.4
 
 # This script reformats (part of) the codebase to make it compliant with our coding guidelines.
 
@@ -7,41 +7,31 @@ param(
     [string] $revision
 )
 
-function VerifySuccessExitCode {
-    if ($LastExitCode -ne 0) {
-        throw "Command failed with exit code $LastExitCode."
-    }
-}
+$ErrorActionPreference = "Stop"
+$PSNativeCommandUseErrorActionPreference = $true
 
 dotnet tool restore
-VerifySuccessExitCode
-
 dotnet restore
-VerifySuccessExitCode
+
+$solutionFile = 'JsonApiDotNetCore.sln'
 
 if ($revision) {
     $headCommitHash = git rev-parse HEAD
-    VerifySuccessExitCode
-
     $baseCommitHash = git rev-parse $revision
-    VerifySuccessExitCode
 
     if ($baseCommitHash -eq $headCommitHash) {
         Write-Output "Running code cleanup on staged/unstaged files."
         dotnet jb cleanupcode --version
-        dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --max-runs=5 --jb --dotnetcoresdk=$(dotnet --version) --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --properties:RunAnalyzers=false --jb --verbosity=WARN -f staged,modified
-        VerifySuccessExitCode
+        dotnet regitlint -s $solutionFile --print-command --skip-tool-check --max-runs=5 --jb --dotnetcoresdk=$(dotnet --version) --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --properties:RunAnalyzers=false --jb --verbosity=WARN -f staged,modified
     }
     else {
         Write-Output "Running code cleanup on commit range $baseCommitHash..$headCommitHash, including staged/unstaged files."
         dotnet jb cleanupcode --version
-        dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --max-runs=5 --jb --dotnetcoresdk=$(dotnet --version) --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --properties:RunAnalyzers=false --jb --verbosity=WARN -f staged,modified,commits -a $headCommitHash -b $baseCommitHash
-        VerifySuccessExitCode
+        dotnet regitlint -s $solutionFile --print-command --skip-tool-check --max-runs=5 --jb --dotnetcoresdk=$(dotnet --version) --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --properties:RunAnalyzers=false --jb --verbosity=WARN -f staged,modified,commits -a $headCommitHash -b $baseCommitHash
     }
 }
 else {
     Write-Output "Running code cleanup on all files."
     dotnet jb cleanupcode --version
-    dotnet regitlint -s JsonApiDotNetCore.sln --print-command --skip-tool-check --jb --dotnetcoresdk=$(dotnet --version) --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --properties:RunAnalyzers=false --jb --verbosity=WARN
-    VerifySuccessExitCode
+    dotnet regitlint -s $solutionFile --print-command --skip-tool-check --jb --dotnetcoresdk=$(dotnet --version) --jb-profile="JADNC Full Cleanup" --jb --properties:Configuration=Release --jb --properties:RunAnalyzers=false --jb --verbosity=WARN
 }

docs/build-dev.ps1

@@ -1,53 +1,64 @@
-#Requires -Version 7.3
+#Requires -Version 7.4
 
 # This script builds the documentation website, starts a web server and opens the site in your browser. Intended for local development.
 
 param(
     # Specify -NoBuild to skip code build and examples generation. This runs faster, so handy when only editing Markdown files.
-    [switch] $NoBuild=$False,
-    # Specify -NoOpen to skip opening the documentation website in a web browser.
-    [switch] $NoOpen=$False
+    [switch] $NoBuild=$false,
+    # Specify -NoOpen to skip opening the documentation website in a web browser (still starts the web server).
+    [switch] $NoOpen=$false
 )
 
-function VerifySuccessExitCode {
-    if ($LastExitCode -ne 0) {
-        throw "Command failed with exit code $LastExitCode."
-    }
-}
+$ErrorActionPreference = "Stop"
+$PSNativeCommandUseErrorActionPreference = $true
+
+# Workaround for bug at https://github.com/PowerShell/PowerShell/issues/23875#issuecomment-2672336383
+$PSDefaultParameterValues['Remove-Item:ProgressAction'] = 'SilentlyContinue'
 
 function EnsureHttpServerIsInstalled {
     if ((Get-Command "npm" -ErrorAction SilentlyContinue) -eq $null) {
         throw "Unable to find npm in your PATH. please install Node.js first."
     }
 
-    # If this command fails with ENOENT after installing Node.js on Windows, manually create the directory %APPDATA%\npm.
-    npm list --depth 1 --global httpserver >$null
+    $global:hasHttpServerInstalled = $true
+
+    & {
+        $PSNativeCommandUseErrorActionPreference = $false
+
+        # Workaround for error ENOENT returned from npm list, after installing Node.js on Windows.
+        # See https://stackoverflow.com/questions/25093276/node-js-windows-error-enoent-stat-c-users-rt-appdata-roaming-npm
+        if ($IsWindows) {
+            New-Item -ItemType Directory -Force -Path $env:APPDATA\npm >$null
+        }
 
-    if ($LastExitCode -eq 1) {
+        npm list --depth 1 --global httpserver >$null
+
+        if ($LastExitCode -eq 1) {
+            Write-Host "httpserver not found."
+            $global:hasHttpServerInstalled = $false
+        }
+    }
+
+    if ($global:hasHttpServerInstalled -eq $false) {
+        Write-Host "Installing httpserver."
         npm install -g httpserver
     }
 }
 
 EnsureHttpServerIsInstalled
-VerifySuccessExitCode
 
 if (-Not $NoBuild -Or -Not (Test-Path -Path _site)) {
     Remove-Item _site\* -Recurse -ErrorAction Ignore
-
-    dotnet build .. --configuration Release
-    VerifySuccessExitCode
-
+    dotnet build .. --configuration Release /p:RunAnalyzers=false
     Invoke-Expression ./generate-examples.ps1
 } else {
     Remove-Item _site\* -Recurse -ErrorAction Ignore
 }
 
 dotnet tool restore
-VerifySuccessExitCode
 
 $env:DOCFX_SOURCE_BRANCH_NAME="dev"
-dotnet docfx ./docfx.json --warningsAsErrors true
-VerifySuccessExitCode
+dotnet docfx docfx.json --warningsAsErrors true
 
 Copy-Item -Force home/*.html _site/
 Copy-Item -Force home/*.ico _site/
@@ -63,7 +74,7 @@ if (-Not $NoOpen) {
 }
 
 Write-Host ""
-Write-Host "Web server started. Press Enter to close."
+Write-Host "Web server started. Site is available at http://localhost:8080. Press Enter to stop web server."
 $key = [Console]::ReadKey()
 
 Stop-Job -Id $webServerJob.Id

docs/generate-examples.ps1

@@ -1,4 +1,6 @@
-#Requires -Version 7.3
+#Requires -Version 7.4
+$ErrorActionPreference = "Stop"
+$PSNativeCommandUseErrorActionPreference = $false
 
 # This script generates HTTP response files (*.json) for .ps1 files in ./request-examples
 

inspectcode.ps1

@@ -1,21 +1,17 @@
-#Requires -Version 7.0
+#Requires -Version 7.4
+$ErrorActionPreference = "Stop"
+$PSNativeCommandUseErrorActionPreference = $true
 
 # This script runs code inspection and opens the results in a web browser.
 
 dotnet tool restore
 
-if ($LastExitCode -ne 0) {
-    throw "Tool restore failed with exit code $LastExitCode"
-}
-
+$solutionFile = 'JsonApiDotNetCore.sln'
 $outputPath = [System.IO.Path]::Combine([System.IO.Path]::GetTempPath(), 'jetbrains-inspectcode-results.xml')
 $resultPath = [System.IO.Path]::Combine([System.IO.Path]::GetTempPath(), 'jetbrains-inspectcode-results.html')
-dotnet jb inspectcode --version
-dotnet jb inspectcode JsonApiDotNetCore.sln --dotnetcoresdk=$(dotnet --version) --build --output="$outputPath" --format="xml" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --properties:RunAnalyzers=false --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=GlobalPerProduct -dsl=SolutionPersonal -dsl=ProjectPersonal
 
-if ($LastExitCode -ne 0) {
-    throw "Code inspection failed with exit code $LastExitCode"
-}
+dotnet jb inspectcode --version
+dotnet jb inspectcode $solutionFile --dotnetcoresdk=$(dotnet --version) --build --output="$outputPath" --format="xml" --profile=WarningSeverities.DotSettings --properties:Configuration=Release --properties:RunAnalyzers=false --severity=WARNING --verbosity=WARN -dsl=GlobalAll -dsl=GlobalPerProduct -dsl=SolutionPersonal -dsl=ProjectPersonal
 
 [xml]$xml = Get-Content "$outputPath"
 if ($xml.report.Issues -and $xml.report.Issues.Project) {

run-docker-postgres.ps1

@@ -5,7 +5,7 @@
 # To connect to pgAdmin, open http://localhost:5050 and login with user "admin@admin.com", password "postgres". Use hostname "db" when registering the server.
 
 param(
-    [switch] $UI=$False
+    [switch] $UI=$false
 )
 
 docker container stop jsonapi-postgresql-db