Improve release automation

baelter · baelter · commit 191d00412cb3 · 2025-09-12T14:36:11.000+02:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -21,12 +21,37 @@ jobs:
       - run: npm install
         env:
           PLAYWRIGHT_SKIP_BROWSER_DOWNLOAD: 1
+      - run: npm run test:local
       - run: npm run build
       - run: npm publish --access public --provenance
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
 
-      - uses: ncipollo/release-action@v1
+        # create GitHub release
+      - name: Extract release notes
+        id: extract_release_notes
+        run: |
+          # Extract version from tag (remove 'v' prefix)
+          VERSION=${GITHUB_REF#refs/tags/v}
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+          # Extract changelog section for this version with better handling
+          if grep -q "## \[$VERSION\]" CHANGELOG.md; then
+            awk "/^## \[$VERSION\]/ {flag=1; next} /^## \[/ && flag {exit} flag && /\S/ {print}" CHANGELOG.md > release_notes.md
+            echo "Release notes extracted for version $VERSION:"
+            cat release_notes.md
+          else
+            echo "No changelog entry found for version $VERSION" > release_notes.md
+            echo "Warning: No changelog entry found for version $VERSION"
+          fi
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
         with:
-          artifacts: "dist/amqp-websocket-client.mjs*"
-          token: ${{ secrets.GITHUB_TOKEN }}
+          name: Release ${{ steps.extract_release_notes.outputs.version }}
+          body_path: release_notes.md
+          draft: false
+          prerelease: false
+          files: |
+            dist/amqp-websocket-client.mjs
+            dist/amqp-websocket-client.mjs.map
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,10 +7,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [3.3.1] - 2025-09-12
-
-## [3.3.0] - 2025-09-12
-
 ### Fixed
 
 - Improve connection loss handling for WebSocket connections ([#152](https://github.com/cloudamqp/amqp-client.js/pull/152))
diff --git a/README.md b/README.md
@@ -174,12 +174,15 @@ The package.json includes several npm scripts for releasing:
 ### What happens during a release
 
 1. **Tests**: All tests are run to ensure everything passes (`preversion`)
-2. **Version bump**: The version is updated in `package.json` and `src/amqp-base-client.ts` (`version`)
-3. **Changelog update**: The `## [Unreleased]` section is converted to the actual version and date (`postversion`)
-4. **Git commit**: A commit is created with the version change and changelog update
-5. **Git tag**: An annotated tag is created with the full changelog content as the tag message
-6. **Push**: Both the commit and tags are pushed to the remote repository
-7. **CI deployment**: The GitHub Actions workflow automatically publishes the new version to npm
+2. **Version bump**: npm automatically updates the version in `package.json`
+3. **File updates**: The version is updated in `src/amqp-base-client.ts`, code is formatted, and changelog is updated (`version`)
+4. **Staging**: All changes are staged for commit (`version`)
+5. **Git commit**: npm automatically commits all staged changes with a version message
+6. **Git tag**: An annotated tag is created with the full changelog content as the tag message (`postversion`)
+7. **Push**: Both the commit and tags are pushed to the remote repository (`postversion`)
+8. **CI deployment**: The GitHub Actions workflow automatically publishes the new version to npm
+
+> **Technical Note**: This release process leverages npm's built-in version lifecycle hooks (`preversion`, `version`, `postversion`). The `npm version` command automatically handles the git commit after running our custom `version` script, which is why we stage changes with `git add -A` rather than committing manually.
 
 ### Prerequisites
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@cloudamqp/amqp-client",
-  "version": "3.3.1",
+  "version": "3.2.0",
   "description": "AMQP 0-9-1 client, both for browsers (WebSocket) and node (TCP Socket)",
   "type": "module",
   "main": "lib/cjs/index.js",
diff --git a/src/amqp-base-client.ts b/src/amqp-base-client.ts
@@ -5,7 +5,7 @@ import { AMQPMessage } from "./amqp-message.js"
 import { AMQPView } from "./amqp-view.js"
 import type { Logger } from "./types.js"
 
-export const VERSION = "3.3.1"
+export const VERSION = "3.2.0"
 
 /**
  * Base class for AMQPClients.

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@cloudamqp/amqp-client",`
`3`		`- "version": "3.3.1",`
	`3`	`+ "version": "3.2.0",`
`4`	`4`	`"description": "AMQP 0-9-1 client, both for browsers (WebSocket) and node (TCP Socket)",`
`5`	`5`	`"type": "module",`
`6`	`6`	`"main": "lib/cjs/index.js",`