Merge pull request #9 from wisedev-code/feat/docs-with-cleanup-and-improvements

Feat/docs with cleanup and improvements

Author: wisedev-pstach

.github/workflows/publish.yml

@@ -42,6 +42,14 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
+          # Create a tag using today's date
           TAG_NAME="v$(date +'%Y.%m.%d')"
-          gh release create "$TAG_NAME" ./artifacts/*.nupkg --title "Release $TAG_NAME" --notes "Automated release of NuGet package."
+          # Get the NuGet package file name from the artifacts folder and remove its extension for the release title
+          NUPKG_FILE=$(basename $(ls ./artifacts/*.nupkg))
+          RELEASE_NAME="${NUPKG_FILE%.*}"
+          # Get the newest markdown file from the Releases folder and read its content as release notes
+          NEWEST_NOTES=$(ls -t Releases/*.md | head -n1)
+          RELEASE_NOTES=$(cat "$NEWEST_NOTES")
+          # Create the GitHub release using the tag, NuGet package and release notes
+          gh release create "$TAG_NAME" ./artifacts/*.nupkg --title "$RELEASE_NAME" --notes "$RELEASE_NOTES"
         shell: bash

.gitignore

@@ -20,7 +20,6 @@ mono_crash.*
 [Dd]ebug/
 [Dd]ebugPublic/
 [Rr]elease/
-[Rr]eleases/
 x64/
 x86/
 [Ww][Ii][Nn]32/
@@ -373,6 +372,8 @@ MigrationBackup/
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
 
+.idea/
+
 # Fody - auto-generated XML schema
 FodyWeavers.xsd