Updates for correct release

* Removed support for pushing docs from scripts
    - That's now a distinct GH action step as things have changed in the back-end on how that works.
* Renamed docs script to `Commit-Docs.ps1` as it now ONLY supports commit.
* Updated release action to reflect changes to docs commit/publish

Author: smaillet

.github/workflows/release-build.yml

@@ -54,12 +54,9 @@ jobs:
         run: ./Build-Docs.ps1
 
       - name: Commit Docs
-        env:
-          docspush_email: 32618965+cibuild-telliam@users.noreply.github.com
-          docspush_username: cibuild-telliam
-        run: .\Push-Docs.ps1 -SkipPush
+        run: .\Commit-Docs.ps1
 
-      - name: Push Docs
+      - name: Publish Docs
         uses: ad-m/github-push-action@master
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
@@ -73,6 +70,4 @@ jobs:
         if: (!cancelled())
         uses: softprops/action-gh-release@v2
         with:
-          tag_name: ${{ github.ref }}
-          release_name: Release ${{ github.ref }}
           draft: true

Push-Docs.ps1 Commit-Docs.ps1Push-Docs.ps1 renamed to Commit-Docs.ps1

@@ -16,57 +16,23 @@ using module "PSModules/RepoBuild/RepoBuild.psd1"
     This is used by automated release builds to essentially "commit" the doc changes before a dedicated step pushes the results.
 #>
 Param(
-    [switch]$FullInit,
-    [switch]$SkipPush
+    [switch]$FullInit
 )
 
 $buildInfo = Initialize-BuildEnvironment -FullInit:$FullInit
 
-Write-Information "Preparing to PUSH updated docs to GitHub IO"
+Write-Information "Preparing to commit updated docs for gh-pages"
 
-$canPush = $env:IsAutomatedBuild -and ($env:IsPullRequestBuild -ieq 'false')
-if(!$canPush)
+$canCommit = $env:IsAutomatedBuild -and ($env:IsPullRequestBuild -ieq 'false')
+if(!$canCommit)
 {
-    Write-Information "Skipping Docs PUSH as this is not an official build"
+    Write-Information "Skipping Docs commit as this is not an official build"
     return;
 }
 
-# Docs must only be updated from a build with the official repository as the default remote.
-# This ensures that the links to source in the generated docs will have the correct URLs
-# (e.g. docs pushed to the official repository MUST not have links to source in some private fork)
-$remoteUrl = Invoke-External git ls-remote --get-url
-
-Write-Information "Remote URL: $remoteUrl"
-
-if($remoteUrl -ne $buildInfo['OfficialGitRemoteUrl'])
-{
-    throw "Pushing docs is only allowed when the origin remote is the official source - current remote is '$remoteUrl'"
-}
-
-if(!$env:docspush_access_token -and !$SkipPush)
-{
-    Write-Error "Missing docspush_access_token" -ErrorAction Stop
-}
-
-if(!$env:docspush_email)
-{
-    Write-Error "Missing docspush_email" -ErrorAction Stop
-}
-
-if(!$env:docspush_username)
-{
-    Write-Error "Missing docspush_username" -ErrorAction Stop
-}
-
 Push-Location .\BuildOutput\docs -ErrorAction Stop
 try
 {
-    if($env:docspush_access_token)
-    {
-        Invoke-External git config --local credential.helper store
-        Add-Content "$env:USERPROFILE\.git-credentials" "https://$($env:docspush_access_token):x-oauth-basic@github.com`n"
-    }
-
     Invoke-External git config --local user.email "$env:docspush_email"
     Invoke-External git config --local user.name "$env:docspush_username"
 
@@ -84,12 +50,6 @@ try
     $msg = "CI Docs Update $(Get-BuildVersionTag $buildInfo)"
     Write-Information "Committing changes to git [$msg]"
     Invoke-External git commit -m"$msg"
-
-    if(!$SkipPush)
-    {
-        Write-Information 'Pushing changes to git'
-        Invoke-External git push
-    }
 }
 catch
 {

src/Ubiquity.NET.Versioning.slnx

@@ -6,6 +6,7 @@
     <File Path="../Build-All.ps1" />
     <File Path="../Build-Docs.ps1" />
     <File Path="../BuildVersion.xml" />
+    <File Path="../Commit-Docs.ps1" />
     <File Path="../Directory.Build.props" />
     <File Path="../Directory.Build.targets" />
     <File Path="../Directory.Packages.props" />
@@ -14,7 +15,6 @@
     <File Path="../Invoke-Tests.ps1" />
     <File Path="../New-GeneratedVersionProps.ps1" />
     <File Path="../Nuget.Config" />
-    <File Path="../Push-Docs.ps1" />
     <File Path="../Push-Nuget.ps1" />
     <File Path="../README.md" />
     <File Path="../Show-Docs.ps1" />