Merge pull request #20 from Stravaig-Projects/#19-fix-mark-release

#19 Fix "Mark Release" build task

Author: colinangusmackay

.github/workflows/build.yml

@@ -10,7 +10,6 @@ on:
       - '.vscode/**'
       - '.gitignore'
       - 'contributors.md'
-      - 'release-notes/**'
       - '.github/PULL_REQUEST_TEMPLATE/**'
       - 'src/.idea/**'
 
@@ -54,6 +53,7 @@ jobs:
 
       - name: Display workflow state
         run: |
+          echo "GITHUB_SHA: $GITHUB_SHA"
           echo "Solution: $STRAVAIG_SOLUTION"
           echo "Project: $STRAVAIG_PROJECT"
           echo "Tests: $STRAVAIG_TESTS"
@@ -67,7 +67,7 @@ jobs:
       - uses: actions/setup-dotnet@v1
         name: Setup .NET Core
         with:
-          dotnet-version: 3.1.404
+          dotnet-version: 3.1.405
 
       - name: Build Solution
         run: dotnet build $STRAVAIG_SOLUTION --configuration Release
@@ -123,19 +123,22 @@ jobs:
             release-notes/full-release-notes.md
             release-notes/release-notes-${{ env.STRAVAIG_PACKAGE_FULL_VERSION }}.md
             out/**
-        
-      - name: Mark Release
+
+      - name: Create Release
         if: ${{ env.STRAVAIG_PUBLISH_TO_NUGET == 'true' }}
-        uses: ncipollo/release-action@v1
-        with:
-          artifacts: "./out/*.nupkg,./out/*.snupkg,LICENSE,contributors.md,readme.md,./release-notes/release-notes-${{ env.STRAVAIG_PACKAGE_FULL_VERSION }}.md"
-          token: ${{ secrets.GITHUB_TOKEN }}
-          bodyFile: "release-body.md"
-          prerelease: ${{ env.STRAVAIG_IS_PREVIEW }}
-          commit: ${{ env.GITHUB_SHA }}
-          tag: v${{ env.STRAVAIG_PACKAGE_FULL_VERSION }}
-          draft: false
-          
+        shell: pwsh
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          $assets = @();
+          $assets += "./out/*.nupkg"
+          $assets += "./out/*.snupkg"
+          $assets += "LICENSE"
+          $assets += "contributors.md"
+          $assets += "README.md"
+          $assets += "./release-notes/release-notes-${{ env.STRAVAIG_PACKAGE_FULL_VERSION }}.md"
+          ./Create-Release.ps1 -IsDraft -NotesFile "./release-body.md" -Assets $assets
+
       - name: Bump version
         #IF Publishing & Stable release
         if: ${{ env.STRAVAIG_PUBLISH_TO_NUGET == 'true' && env.STRAVAIG_IS_STABLE == 'true' }}

.vscode/settings.json

@@ -1,3 +1,13 @@
 {
-    "restructuredtext.confPath": ""
+    "restructuredtext.confPath": "",
+    "cSpell.words": [
+        "Dependabot",
+        "Dependabots",
+        "Nuget",
+        "Stravaig",
+        "commitish",
+        "nupkg",
+        "pwsh",
+        "snupkg"
+    ]
 }

Create-Release.ps1

@@ -0,0 +1,94 @@
+[CmdletBinding()]
+param
+(
+    [parameter(Mandatory=$false)]
+    [switch]$IsDraft,
+
+    [ValidateScript({Test-Path $_ -PathType Leaf})]
+    [parameter(Mandatory=$true)]
+    [string]$NotesFile,
+
+    [ValidateScript({Test-Path $_ -PathType Leaf})]
+    [parameter(Mandatory=$false)]
+    [string[]]$Assets
+)
+
+function Invoke-GitHub([string]$ghArgs)
+{
+    $pinfo = New-Object System.Diagnostics.ProcessStartInfo
+    $pinfo.FileName = "gh"
+    $pinfo.UseShellExecute = $false
+    $pinfo.Arguments = $ghArgs
+    Write-Verbose -Message $pinfo.Arguments
+    $ghProcess = New-Object System.Diagnostics.Process
+    $ghProcess.StartInfo = $pinfo
+    $null = $ghProcess.Start();
+    $ghProcess.WaitForExit();
+    return $ghProcess.ExitCode;
+}
+
+if ([string]::IsNullOrWhiteSpace($Env:GITHUB_TOKEN))
+{
+    Write-Error "GITHUB_TOKEN environment variable is missing."
+    Exit 1;
+}
+
+if ([string]::IsNullOrWhiteSpace($Env:GITHUB_SHA))
+{
+    Write-Error "GITHUB_SHA is missing."
+    Exit 2;
+}
+$Commitish = $Env:GITHUB_SHA;
+
+if ([string]::IsNullOrWhiteSpace($Env:STRAVAIG_PACKAGE_FULL_VERSION))
+{
+    Write-Error "STRAVAIG_PACKAGE_FULL_VERSION is missing."
+    Exit 3;
+}
+$TagName = "v" + $Env:STRAVAIG_PACKAGE_FULL_VERSION
+
+
+if ([string]::IsNullOrWhiteSpace($Env:STRAVAIG_IS_PREVIEW))
+{
+    Write-Error "STRAVAIG_IS_PREVIEW is missing."
+    Exit 4;
+}
+$IsPrerelease = [System.Convert]::ToBoolean($Env:STRAVAIG_IS_PREVIEW);
+
+
+$ghArgs = "release create `"$TagName`""
+foreach($assetPath in $Assets)
+{
+    $specificAssets = Get-Item $assetPath;
+    foreach($specificAsset in $specificAssets)
+    {
+        if (-not $specificAsset.PSIsContainer)
+        {
+            $fileName = $specificAsset.FullName;
+            $ghArgs += " `"$fileName`""
+        }
+        else 
+        {
+            Write-Verbose "Skipping `"$specificAsset`" as it refers to a directory. Must provide paths to files."
+        }
+    }
+}
+
+
+
+$ghArgs += " --title `"Release of $TagName`" --target $Commitish --notes-file `"$NotesFile`""
+if ($IsDraft)
+{
+    $ghArgs += " --draft"
+}
+if ($IsPrerelease)
+{
+    $ghArgs += " --prerelease"
+}
+$exitCode = Invoke-GitHub $ghArgs
+if ($exitCode -ne 0)
+{
+    Write-Error "Failed to create a release."
+    Exit $exitCode;
+}
+

Reset-WipReleaseNotes.ps1

@@ -10,6 +10,9 @@ $content = @(
 "### Features",
 "",
 "### Miscellaneous",
+"",
+"### Dependabot"
+"",
 ""
 )
 

release-notes/wip-release-notes.md

@@ -10,3 +10,17 @@ Date: ???
 
 ### Miscellaneous
 
+* #19: Fix release process.
+  * Bump SDK version
+  * Create release to PowerShell/GitHub CLI
+  * Release notes now includes a Dependabots section
+
+### Dependabot
+
+* Bump `NUnit` from 3.12.0 to 3.13.0
+* Bump `Microsoft.Extensions.Configuration.Json` from 3.1.10 to 3.1.11
+* Bump `Microsoft.Extensions.DependencyInjection.Abstractions` from 3.1.10 to 3.1.11
+* Bump `Microsoft.Extensions.Logging.Abstractions` from 3.1.10 to 3.1.11
+* Bump `Microsoft.Extensions.Options` from 3.1.10 to 3.1.11
+* Bump `Microsoft.Extensions.Options.ConfigurationExtensions` from 3.1.10 to 3.1.11
+* Bump `Stravaig.Extensions.Logging.Diagnostics` from 0.3.0 to 0.3.1