Make notes pretty

MystenLabs · Aug 19, 2024 · 8c2f8c9 · 8c2f8c9
1 parent 8184ea9
commit 8c2f8c9
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/.github/workflows/release-notes-generator.yml b/.github/workflows/release-notes-generator.yml
@@ -19,6 +19,9 @@ on:
         required: true
         default: releases/sui-v1.30.0-release
 
+env:
+  RELEASE_NOTES_FILE: "./release_notes.txt"
+
 jobs:
   get-release-notes:
     name: Get Release Notes for ${{ inputs.release_tag }} release
@@ -62,7 +65,8 @@ jobs:
         shell: bash
         working-directory: ./
         run: |
-          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} python ./scripts/release_notes.py generate ${{ env.previous_commit }} ${{ env.current_commit }} | tee -a ./release_notes.txt
+          GITHUB_TOKEN=${{ secrets.GITHUB_TOKEN }} python ./scripts/release_notes.py generate ${{ env.previous_commit }} ${{ env.current_commit }} | tee -a ${{ env.RELEASE_NOTES_FILE }}
+          echo "### Full Log: https://github.com/MystenLabs/sui/commits/${{ inputs.release_tag }}" >> ${{ env.RELEASE_NOTES_FILE }}
 
           if [[ ${{ inputs.release_tag }} == devnet* ]]; then
             echo "pre_release=true" >> $GITHUB_ENV

diff --git a/scripts/release_notes.py b/scripts/release_notes.py
@@ -304,7 +304,7 @@ def do_generate(from_, to):
         print(f"## {impacted}")
 
         if impacted == "Protocol":
-            print(f"Sui Protocol Version in this release: {protocol_version}")
+            print(f"###Sui Protocol Version in this release: `{protocol_version}`")
         print()
 
         for pr, note in reversed(notes):