Feature/update release notes (#20)

* new format for release notes

* update changelog with commit messages

Author: AnthonyGress

.github/release.yml

@@ -0,0 +1,18 @@
+changelog:
+  categories:
+    - title: New Features
+      labels:
+        - feature
+        - enhancement
+    - title: Bug Fixes
+      labels:
+        - bug
+        - fix
+        - bugfix
+    - title: Other Changes
+      labels:
+        - '*'
+  exclude:
+    labels:
+      - dependencies
+      - automation

.github/workflows/deploy.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Checkout git repo
         uses: actions/checkout@v4
         with:
-          fetch-depth: 0  # Fetch all history for proper release notes
+          fetch-depth: 0  # Fetch all history for release notes
 
       - name: Install Node and NPM
         uses: actions/setup-node@v4
@@ -51,23 +51,18 @@ jobs:
       - name: Create Release
         if: steps.version_check.outputs.versionChanged == 'true'
         run: |
-          # Get the previous version tag
-          PREV_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
+          # Get the previous version tag or initial commit
+          PREV_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo $(git rev-list --max-parents=0 HEAD))
+          CURR_TAG="v${{ steps.version_check.outputs.rawVersion }}"
 
-          if [ -z "$PREV_TAG" ]; then
-            # If no previous tag exists, use the first commit
-            PREV_COMMIT=$(git rev-list --max-parents=0 HEAD)
-            COMMIT_RANGE="$PREV_COMMIT..HEAD"
-          else
-            COMMIT_RANGE="$PREV_TAG..HEAD"
-          fi
+          # Generate simple release notes with commit messages
+          NOTES=$(git log --pretty=format:"* %s" $PREV_TAG..HEAD --no-merges)
+          echo "## What's Changed" > release_notes.md
+          echo "" >> release_notes.md
+          echo "$NOTES" >> release_notes.md
 
-          # Generate release notes with commit messages
-          RELEASE_NOTES=$(echo -e "## What's Changed\n\n")
-          RELEASE_NOTES+=$(git log $COMMIT_RANGE --pretty=format:"* %s" --no-merges)
-
-          # Create release with the generated notes
-          gh release create "v${{ steps.version_check.outputs.rawVersion }}" --notes "$RELEASE_NOTES"
+          # Create the release with notes
+          gh release create "$CURR_TAG" --notes-file release_notes.md
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}