feat: generate CHANGELOG.md, added permission "pull-requests" for semantic-release, renamed a few steps to make them more clear

Author: TimPietrusky

.github/workflows/release.yml

@@ -11,8 +11,9 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ !contains(github.event.head_commit.message, 'chore(release)') }}
     permissions:
-      contents: write
-      issues: write
+      contents: write # to be able to publish a GitHub release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
 
     steps:
       - name: Checkout
@@ -41,12 +42,12 @@ jobs:
         uses: codfish/semantic-release-action@v3
         id: semanticrelease
         with: 
-            additional-packages: |
-                ['@semantic-release/git']
+          additional-packages: |
+            ['@semantic-release/git', '@semantic-release/changelog']
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Build and push
+      - name: Build image and push it to Docker Hub
         if: steps.semanticrelease.outputs.new-release-published == 'true'
         uses: docker/build-push-action@v5
         with:
@@ -55,7 +56,7 @@ jobs:
             ${{ secrets.DOCKERHUB_REPO }}/${{ secrets.DOCKERHUB_IMG }}:${{ steps.semanticrelease.outputs.release-version }}
             ${{ secrets.DOCKERHUB_REPO }}/${{ secrets.DOCKERHUB_IMG }}:latest
   
-      - name: Docker Hub Description
+      - name: Update description on Docker Hub
         if: steps.semanticrelease.outputs.new-release-published == 'true'
         uses: peter-evans/dockerhub-description@v3
         with:

.releaserc

@@ -6,10 +6,16 @@
   "plugins": [
     "@semantic-release/commit-analyzer",
     "@semantic-release/release-notes-generator",
+    [
+        "@semantic-release/changelog",
+        {
+          "changelogFile": "CHANGELOG.md"
+        }
+      ],
     [
       "@semantic-release/git",
       {
-        "assets": [],
+        "assets": ["CHANGELOG.md"],
         "message": "chore(release): ${nextRelease.version} \n\n${nextRelease.notes}"
       }
     ],