fix: Correct the build process to push release notes through for the …

…public website
OctopusDeploy · Aug 18, 2022 · 8fe03ba · 8fe03ba
1 parent 822dee9
commit 8fe03ba
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 5 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -4,7 +4,7 @@ on:
   push:
     branches: '**'
   release:
-    types: [published]
+    types: [created]
   schedule:
     # Daily 5am australian/brisbane time (7pm UTC)
     - cron: '0 19 * * *'
@@ -14,6 +14,8 @@ jobs:
   build:
     name: Build and unit test code
     runs-on: windows-latest
+    # conditionally skip build on PR merge of release-please, because the release creation is going to trigger the real build
+    if: ${{ github.ref_name != github.event.repository.default_branch || github.event.head_commit.author.username != 'team-integrations-fnm-bot' }}
     outputs:
       version: ${{ steps.nuke-build.outputs.version }}
     steps:
@@ -245,12 +247,22 @@ jobs:
           artifacts/OctopusTools.Packages.linux-x64.${{ needs.build.outputs.version }}.zip
           artifacts/OctopusTools.Zips.${{ needs.build.outputs.version }}.zip
 
+    - name: Fetch Release Notes
+      id: fetch-release-notes
+      if: github.event_name == 'release'
+      run: |
+        echo "::debug::${{github.event_name}}"
+        OUTPUT_FILE="release_notes.txt"
+        jq --raw-output '.release.body' ${{ github.event_path }} | sed 's#\r#  #g' > $OUTPUT_FILE
+        echo "::set-output name=release-note-file::$OUTPUT_FILE"
+
     - name: Create a release in Octopus Deploy 🐙
       uses: OctopusDeploy/[email protected]
       with:
         space: Integrations
         project: 'Octopus CLI'
         package_version: ${{ needs.build.outputs.version }}
         packages: '*:NuGet.CommandLine:4.4.1'
-        git_ref: ${{ (github.ref_type == 'tag' && 'main' ) || (github.head_ref || github.ref) }}
+        release_notes_file: ${{ (github.event_name == 'release' && steps.fetch-release-notes.outputs.release-note-file) || ''}}
+        git_ref: ${{ (github.ref_type == 'tag' && github.event.repository.default_branch ) || (github.head_ref || github.ref) }}
         git_commit: ${{ github.event.after || github.event.pull_request.head.sha }}
diff --git a/.octopus/deployment_process.ocl b/.octopus/deployment_process.ocl
@@ -400,7 +400,7 @@ step "create-release-in-slipway" {
                 $slipwayToken = $OctopusParameters["SlipwayToken"]
                 $baseUrl = $OctopusParameters["SlipwayUrl"]
                 $version = $OctopusParameters["Octopus.Release.Number"]
-                $releaseNotes = $OctopusParameters["Octopus.Release.Notes"]
+                $releaseNotes = $OctopusParameters["Octopus.Deployment.ChangesMarkdown"]
 
                 $headers = @{ "Authorization" = "Bearer $slipwayToken" }
 
@@ -416,7 +416,7 @@ step "create-release-in-slipway" {
                         "IsPrerelease" = $isPreRelease;
                         "IsPublic" = $true;
                         "ReleaseNotes" = $releaseNotes;
-                        "ReleaseNotesMethod" = "GitRevisionGraph";
+                        "ReleaseNotesMethod" = "Milestones";
                     }
 
                     write-verbose "POSTing the following JSON to $baseUrl/api/releases/create"

diff --git a/.octopus/deployment_settings.ocl b/.octopus/deployment_settings.ocl
@@ -1,3 +1,9 @@
+deployment_changes_template = <<-EOT
+        #{each release in Octopus.Deployment.Changes}
+        #{release.ReleaseNotes}
+        #{/each}
+    EOT
+
 connectivity_policy {
 }
 

diff --git a/.octopus/schema_version.ocl b/.octopus/schema_version.ocl
@@ -1 +1 @@
-version = 4
+version = 5