Use CHANGELOG for release description

`goreleaser` use git commits for building release description. It is sorted by commit messages and does not provide a clarity. Update release workflow to extract sevversion changelog from `CHANGELOG.md` and use it for `goreleaser`.
Shopify · Sep 1, 2021 · 6e756a8 · 6e756a8
1 parent 758c1e5
commit 6e756a8
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 3 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -36,12 +36,19 @@ jobs:
         with:
           go-version: 1.17
 
+      -
+        name: Build release changelog
+        run: |
+          version=${GITHUB_REF#refs/tags/v*}
+          mkdir -p tmp
+          sed '/^# \['$version'\]/,/^# \[/!d;//d;/^\s*$/d' CHANGELOG.md > tmp/release_changelog.md
+
       -
         name: Release
         uses: goreleaser/goreleaser-action@5a54d7e660bda43b405e8463261b3d25631ffe86
         with:
           distribution: goreleaser
           version: v0.176.0
-          args: release --rm-dist
+          args: release --rm-dist --release-notes=tmp/release_changelog.md
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,5 @@ dist/
 
 # go mod dependencies
 vendor/
+
+tmp/
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -40,7 +40,7 @@ builds:
   - <<: *build_default
     id: client
     main: ./cli
-    binary: toxiproxy-client-{{.Os}}-{{.Arch}}
+    binary: toxiproxy-cli-{{.Os}}-{{.Arch}}
 
 checksum:
   name_template: checksums.txt
@@ -125,6 +125,7 @@ changelog:
     exclude:
       - '^docs:'
       - '^test:'
+      - '^Merge'
 
 archives:
   -

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,6 @@
 # [Unreleased]
 
+* Use CHANGELOG.md for release description (#306, @miry)
 
 # [2.1.5]
 

diff --git a/dev.yml b/dev.yml
@@ -7,5 +7,5 @@ up:
       - gnu-tar
       - goreleaser
   - go:
-      version: 1.16
+      version: 1.17
       modules: true