Add GH release step on CI and tweak changelog styles (#31)

* Add GH release step on CI and tweak changelog styles * Move links to under headings --------- Co-authored-by: Jake Wharton <[email protected]>
cashapp · Oct 18, 2024 · dbd2017 · dbd2017
1 parent 72befa1
commit dbd2017
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 14 deletions.
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -11,7 +11,8 @@ env:
 jobs:
   publish:
     runs-on: macos-latest
-
+    permissions:
+      contents: write
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-java@v4
@@ -25,9 +26,13 @@ jobs:
           ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.SONATYPE_NEXUS_PASSWORD }}
           ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.ARTIFACT_SIGNING_PRIVATE_KEY }}
 
-      - uses: ffurrer2/extract-release-notes@v2
-        id: release_notes
-
-      - uses: ncipollo/release-action@v1
+      - name: Extract release notes
+        id: extract-release-notes
+        uses: ffurrer2/extract-release-notes@v2
         with:
-          body: ${{ steps.release_notes.outputs.release_notes }}
+          release_notes_file: RELEASE_NOTES.md
+
+      - name: Create GitHub release
+        run: gh release create ${{ github.ref_name }} --notes-file RELEASE_NOTES.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,30 +1,45 @@
 # Change Log
 
-## Unreleased
+## [Unreleased]
+[Unreleased]: https://github.com/cashapp/burst/compare/0.5.0...HEAD
 
-## Version 0.5.0 *(2024-10-17)*
 
- * Fix: Apply specializations for Kotlin/JS and Kotlin/Native. We had bugs that caused our compiler
-   plug-in to skip non-JVM platforms.
+## [0.5.0] *(2024-10-17)*
+[0.5.0]: https://github.com/cashapp/burst/releases/tag/0.4.0
 
+**Fixed**
 
-## Version 0.4.0 *(2024-10-16)*
+* Fix: Apply specializations for Kotlin/JS and Kotlin/Native. We had bugs that caused our compiler
+  plug-in to skip non-JVM platforms.
+
+
+## [0.4.0] *(2024-10-16)*
+[0.4.0]: https://github.com/cashapp/burst/releases/tag/0.4.0
+
+**Added**
 
  * New: Require JDK 1.8+.
  * New: Run the first specialization when launching from the IDE.
 
 
-## Version 0.3.0 *(2024-10-15)*
+## [0.3.0] *(2024-10-15)*
+[0.3.0]: https://github.com/cashapp/burst/releases/tag/0.3.0
+
+**Fixed**
 
  * Fix: Don't generate invalid bytecode by attaching a test class constructor to its enclosing file.
 
 
-## Version 0.3.0 *(2024-10-10)*
+## [0.2.0] *(2024-10-10)*
+[0.2.0]: https://github.com/cashapp/burst/releases/tag/0.2.0
+
+**Added**
 
  * New: Support both class constructor parameters and test function parameters.
 
 
-## Version 0.1.0 *(2024-10-08)*
+## [0.1.0] *(2024-10-08)*
+[0.1.0]: https://github.com/cashapp/burst/releases/tag/0.1.0
 
 Initial release. We're rebooting the [Burst] project that released 1.0 ten years ago.