🏆 Improve release pipeline and generate release notes (#270)

* 💚 Add release config file for generating changelog * 👷‍♂️ Simplify .NET setup step * 👷‍♂️ Use new GitHub action for creating releases
beardgame · Apr 29, 2022 · 8faa40b · 8faa40b
1 parent cf667e0
commit 8faa40b
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 26 deletions.
diff --git a/.github/release.yml b/.github/release.yml
@@ -0,0 +1,23 @@
+changelog:
+  exclude:
+    labels:
+      - dependencies
+      - ignore-for-release
+    authors:
+      - dependabot
+      - octocat
+  categories:
+    - title: 💥 Breaking changes
+      labels:
+        - breaking-change
+    - title: ✨ New features
+      labels:
+        - enhancement
+        - feature
+    - title: 🐛 Bugfixes
+      labels:
+        - bug
+        - fix
+    - title: 📝 Other changes
+      labels:
+        - "*"
diff --git a/.github/workflows/dotnet-build.yml b/.github/workflows/dotnet-build.yml
@@ -14,18 +14,13 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Setup .NET Core 3.1
+      - name: Setup .NET
         uses: actions/setup-dotnet@v2
         with:
-          dotnet-version: 3.1.x
-      - name: Setup .NET Core 5.0
-        uses: actions/setup-dotnet@v2
-        with:
-          dotnet-version: 5.0.x
-      - name: Setup .NET Core 6.0
-        uses: actions/setup-dotnet@v2
-        with:
-          dotnet-version: 6.0.x
+          dotnet-version: |
+            3.1.x
+            5.0.x
+            6.0.x
       - name: Install dependencies
         run: dotnet restore
       - name: Build
@@ -40,7 +35,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v3
-      - name: Setup .NET Core 6.0
+      - name: Setup .NET
         uses: actions/setup-dotnet@v2
         with:
           dotnet-version: 6.0.x

diff --git a/.github/workflows/dotnet-publish.yml b/.github/workflows/dotnet-publish.yml
@@ -14,18 +14,13 @@ jobs:
     steps:
       # Build library and run tests
       - uses: actions/checkout@v3
-      - name: Setup .NET Core 3.1
+      - name: Setup .NET
         uses: actions/setup-dotnet@v2
         with:
-          dotnet-version: 3.1.x
-      - name: Setup .NET Core 5.0
-        uses: actions/setup-dotnet@v2
-        with:
-          dotnet-version: 5.0.x
-      - name: Setup .NET Core 6.0
-        uses: actions/setup-dotnet@v2
-        with:
-          dotnet-version: 6.0.x
+          dotnet-version: |
+            3.1.x
+            5.0.x
+            6.0.x
       - name: Install dependencies
         run: dotnet restore
       - name: Build
@@ -49,15 +44,15 @@ jobs:
 
       # Create a GitHub release
       - name: Create a Release
-        id: create_release
-        uses: actions/create-release@v1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: softprops/action-gh-release@v1
         with:
           tag_name: ${{ env.RELEASE_VERSION }}
-          release_name: Release ${{ env.RELEASE_VERSION }}
+          name: Release ${{ env.RELEASE_VERSION }}
           draft: false
           prerelease: ${{ contains(env.RELEASE_VERSION, '-') }}
+          generate_release_notes: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+          files: "**/*.nupkg"
 
       # Push the NuGet package to the package providers
       - name: Push release to NuGet