modify: Automatically generate release note with changelog.

.github/actions/release-build/action.yaml

@@ -16,6 +16,7 @@ runs:
         sbt "release with-defaults"
 
     - name: "Export Current Version"
+      id: export-current-version
       shell: bash
       run: |
         git describe --tags --abbrev=0

.github/actions/upload-to-github-release/action.yaml

@@ -13,6 +13,21 @@ runs:
       run: |
         ./scripts/packageBundles.sh
  
+    - name: "Extract Changelog of Current Version"
+      id: extract-changelog
+      uses: sean0x42/markdown-extract@v2
+      with:
+        file: CHANGELOG.md
+        pattern: ${{ env.CURRENT_VERSION }}
+
+    - name: "Prepare Release Note"
+      shell: bash
+      run: |
+        echo "# Change Log" >> ./doc/RELEASE.md
+        echo "${{ steps.extract-changelog.outputs.markdown }}" >> ./doc/RELEASE.md
+        echo "# Installation" >> ./doc/RELEASE.md
+        cat doc/INSTALL.md >> ./doc/RELEASE.md
+
     - name: "Create GitHub Release Page"
       uses: xresloader/upload-to-github-release@v1.6.0
       with:

.github/workflows/release.yaml

@@ -2,7 +2,7 @@ name: Release
 
 on:
   push:
-    branches: ["release"]
+    branches: ["master"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -51,5 +51,3 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           branch: ${{ github.ref }}
-
-

.gitignore

@@ -7,3 +7,4 @@ project/target
 .DS_Store
 .bsp/
 .attach*
+doc/RELEASE.md

CHANGELOG.md

@@ -6,8 +6,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-[Unreleased]
--------------
+## [Unreleased]
 
 ### Fixed
 
@@ -20,23 +19,21 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Use Debian as a building environment in GitHub Actions CI pipeline.
   - Enable AudioOutputTest in GitHub Actions CI pipeline.
 
-2.0.2
------
+## v2.0.2
 
 ### Fixed
 
 - Fixed some Live2D model will yield `IndexOutOfBoundException: Required 1 remaining elements in buffer, only had 0` when using JavaOpenGLBinding to render the Live2D model. (Issue [#3](https://github.com/brianhsu/Live2DForScala/issues/3))
 - Fixed Java Swing Example yield `java.lang.IllegalArgumentException: setSelectedIndex: 0 out of bounds` and crash during startup if there is no webcam.
 
-2.0.1
--------------
+## v2.0.1
 
 ### Fixed
 
 - Fixed `FileNotFound` exception when use pre-built Maven JAR files and loading avatar through AvatarFileReader. (Issue [#2](https://github.com/brianhsu/Live2DForScala/issues/2)).
 
-2.0.0
--------------
+## v2.0.0
+
 This version basically aligned to Cubism Native SDK 4-r.5-beta.4.
 
 ### Added
@@ -67,8 +64,7 @@ This version basically aligned to Cubism Native SDK 4-r.5-beta.4.
 - Move Parameter / JVMParameter / CPointerParameter to separate package `moe.brianhsu.live2d.enitiy.model.parameter`.
 
 
-1.0.0
--------------
+## v1.0.0
 
 ### Added
 

README.md

@@ -214,7 +214,7 @@ sbt:live2dforscala> compile
 sbt:live2dforscala> 
 ```
 
-### 3. Compile
+### 3. Unit Test
 
 - Type `test` in SBT console to run unit test.
 - Since MacOS does not support SWT+JWJGL, SWTOpenGLCanvasInfoFeature would faild. It's expected.
@@ -256,6 +256,18 @@ sbt:live2dforscala> exampleSWTLinux/run
 [info] running (fork) moe.brianhsu.live2d.demo.swing.SwingMain
 ```
 
+Contribution
+==============================
+
+If you find any bugs, you could report it under the [GitHub Issue](https://github.com/brianhsu/Live2DForScala/issues) tab.
+
+You are more then welcome to send pull request to this project. Here are some guidelines for pull requests:
+
+1. `master` branch are reserved for release a new version, please base your code on `develop` branch. `devlope` branch contains all the latest code.
+2. Please send pull request to `develop` branch.
+3. Large pull request is hard to do a meaningful review, please consider [split large PR to small PR](https://google.github.io/eng-practices/review/developer/small-cls.html).
+4. Please run unit test and make sure everything passed before sending a PR.
+
 License
 ==============================