**chore(release): enhance deployment workflows with GitHub release automation**

- Added functionality to auto-generate GitHub releases:
  - Included `scripts/create-github-release.js` to automate release creation with notes.
  - Modified `scripts/publish-cli.js` to create GitHub releases after publishing packages.
  - Updated `package.json` to call the GitHub release script during `deploy` and `deploy:cli` commands.
- Introduced `CHANGELOG.md` for both main and CLI packages:
  - Enabled auto-updating of CHANGELOG.md from GitHub release notes.
  - Added a new `scripts/update-changelog.js` script to synchronize release details with changelogs.
  - Ensured `CHANGELOG.md` files are included in the published packages.
- Improved documentation visibility by displaying release notes on npmjs.com.

This update streamlines the release process, ensuring consistent documentation, and aligns npm releases with corresponding GitHub releases for better transparency.
This commit is contained in:
David Snelling 2025-07-04 12:29:38 -07:00
parent 20c114dd3e
commit 4fb1a29a13
7 changed files with 257 additions and 2 deletions

View file

@ -44,8 +44,8 @@
"check-format": "prettier --check \"src/**/*.{ts,js}\"",
"check-style": "node scripts/check-code-style.js",
"prepare": "npm run build",
"deploy": "npm run build && npm publish",
"deploy:cli": "node scripts/generate-version.js && cd cli-package && npm run build && npm publish",
"deploy": "npm run build && npm publish && node scripts/create-github-release.js",
"deploy:cli": "node scripts/generate-version.js && cd cli-package && npm run build && npm publish && node ../scripts/create-github-release.js",
"deploy:both": "node scripts/publish-cli.js",
"deploy:cloud:aws": "cd cloud-wrapper && npm run build && npm run deploy:aws",
"deploy:cloud:gcp": "cd cloud-wrapper && npm run build && npm run deploy:gcp",
@ -93,6 +93,7 @@
"dist/utils/",
"LICENSE",
"README.md",
"CHANGELOG.md",
"brainy.png"
],
"devDependencies": {