mirror of
https://github.com/xtr-dev/payload-mailing.git
synced 2025-12-10 08:13:23 +00:00
feat: add automated version management with AI-generated changelogs
- Created version/major, version/minor, and version/patch branches for semantic versioning - Added GitHub Actions workflow for automated version bumping and publishing - Integrated Claude Code CLI for AI-generated changelogs in commit messages and releases - Added comprehensive documentation for version workflow usage - Workflow includes testing, building, NPM publishing, and GitHub releases - Changelog categorizes changes into Features, Bug Fixes, Improvements, Documentation, and Performance
This commit is contained in:
191
.github/workflows/version-and-publish.yml
vendored
Normal file
191
.github/workflows/version-and-publish.yml
vendored
Normal file
@@ -0,0 +1,191 @@
|
|||||||
|
name: Version and Publish
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
types: [closed]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
version-and-publish:
|
||||||
|
if: github.event_name == 'push' || (github.event.pull_request.merged == true && (contains(github.event.pull_request.head.ref, 'version/major') || contains(github.event.pull_request.head.ref, 'version/minor') || contains(github.event.pull_request.head.ref, 'version/patch')))
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
|
||||||
|
- name: Setup Node.js
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: '18'
|
||||||
|
registry-url: 'https://registry.npmjs.org'
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: npm test
|
||||||
|
|
||||||
|
- name: Run build
|
||||||
|
run: npm run build
|
||||||
|
|
||||||
|
- name: Determine version bump type
|
||||||
|
id: version-type
|
||||||
|
run: |
|
||||||
|
if [[ "${{ github.event.pull_request.head.ref }}" =~ version/major ]]; then
|
||||||
|
echo "type=major" >> $GITHUB_OUTPUT
|
||||||
|
elif [[ "${{ github.event.pull_request.head.ref }}" =~ version/minor ]]; then
|
||||||
|
echo "type=minor" >> $GITHUB_OUTPUT
|
||||||
|
elif [[ "${{ github.event.pull_request.head.ref }}" =~ version/patch ]]; then
|
||||||
|
echo "type=patch" >> $GITHUB_OUTPUT
|
||||||
|
elif [[ "${{ github.event_name }}" == "push" ]]; then
|
||||||
|
# Default to patch for direct pushes to main
|
||||||
|
echo "type=patch" >> $GITHUB_OUTPUT
|
||||||
|
else
|
||||||
|
echo "type=none" >> $GITHUB_OUTPUT
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Configure git
|
||||||
|
if: steps.version-type.outputs.type != 'none'
|
||||||
|
run: |
|
||||||
|
git config --global user.name "github-actions[bot]"
|
||||||
|
git config --global user.email "github-actions[bot]@users.noreply.github.com"
|
||||||
|
|
||||||
|
- name: Install Claude Code CLI
|
||||||
|
if: steps.version-type.outputs.type != 'none'
|
||||||
|
run: |
|
||||||
|
curl -fsSL https://claude.ai/cli/install.sh | bash
|
||||||
|
echo "$HOME/.claude/bin" >> $GITHUB_PATH
|
||||||
|
|
||||||
|
- name: Generate changelog with Claude
|
||||||
|
if: steps.version-type.outputs.type != 'none'
|
||||||
|
id: changelog
|
||||||
|
run: |
|
||||||
|
# Get commits since last tag
|
||||||
|
LAST_TAG=$(git describe --tags --abbrev=0 2>/dev/null || echo "")
|
||||||
|
if [ -z "$LAST_TAG" ]; then
|
||||||
|
COMMITS=$(git log --oneline --no-merges --since="1 week ago")
|
||||||
|
else
|
||||||
|
COMMITS=$(git log --oneline --no-merges ${LAST_TAG}..HEAD)
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Generate changelog using Claude
|
||||||
|
CHANGELOG=$(claude-code << EOF
|
||||||
|
Please analyze the following git commits and generate a concise changelog in this exact format:
|
||||||
|
|
||||||
|
## Changes
|
||||||
|
|
||||||
|
### 🚀 Features
|
||||||
|
- Brief description of new features
|
||||||
|
|
||||||
|
### 🐛 Bug Fixes
|
||||||
|
- Brief description of bug fixes
|
||||||
|
|
||||||
|
### 🔧 Improvements
|
||||||
|
- Brief description of improvements/refactoring
|
||||||
|
|
||||||
|
### 📚 Documentation
|
||||||
|
- Brief description of documentation changes
|
||||||
|
|
||||||
|
### ⚡ Performance
|
||||||
|
- Brief description of performance improvements
|
||||||
|
|
||||||
|
Only include sections that have actual changes. Keep each bullet point concise and user-focused.
|
||||||
|
|
||||||
|
Git commits to analyze:
|
||||||
|
$COMMITS
|
||||||
|
EOF
|
||||||
|
)
|
||||||
|
|
||||||
|
# Save changelog to output
|
||||||
|
echo "changelog<<EOF" >> $GITHUB_OUTPUT
|
||||||
|
echo "$CHANGELOG" >> $GITHUB_OUTPUT
|
||||||
|
echo "EOF" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
- name: Version bump
|
||||||
|
if: steps.version-type.outputs.type != 'none'
|
||||||
|
id: version-bump
|
||||||
|
run: |
|
||||||
|
# Get current version
|
||||||
|
CURRENT_VERSION=$(node -p "require('./package.json').version")
|
||||||
|
echo "current-version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
# Bump version
|
||||||
|
npm version ${{ steps.version-type.outputs.type }} --no-git-tag-version
|
||||||
|
|
||||||
|
# Get new version
|
||||||
|
NEW_VERSION=$(node -p "require('./package.json').version")
|
||||||
|
echo "new-version=$NEW_VERSION" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
# Create commit with changelog
|
||||||
|
git add package.json package-lock.json
|
||||||
|
git commit -m "chore: bump version to v$NEW_VERSION
|
||||||
|
|
||||||
|
${{ steps.changelog.outputs.changelog }}"
|
||||||
|
|
||||||
|
# Create git tag
|
||||||
|
git tag -a "v$NEW_VERSION" -m "Version $NEW_VERSION
|
||||||
|
|
||||||
|
${{ steps.changelog.outputs.changelog }}"
|
||||||
|
|
||||||
|
echo "Version bumped from $CURRENT_VERSION to $NEW_VERSION"
|
||||||
|
|
||||||
|
- name: Push version changes
|
||||||
|
if: steps.version-type.outputs.type != 'none'
|
||||||
|
run: |
|
||||||
|
git push origin main
|
||||||
|
git push origin --tags
|
||||||
|
|
||||||
|
- name: Publish to NPM
|
||||||
|
if: steps.version-type.outputs.type != 'none'
|
||||||
|
run: npm publish --access public
|
||||||
|
env:
|
||||||
|
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
|
||||||
|
|
||||||
|
- name: Create GitHub Release
|
||||||
|
if: steps.version-type.outputs.type != 'none'
|
||||||
|
uses: actions/create-release@v1
|
||||||
|
env:
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
with:
|
||||||
|
tag_name: v${{ steps.version-bump.outputs.new-version }}
|
||||||
|
release_name: Release v${{ steps.version-bump.outputs.new-version }}
|
||||||
|
body: |
|
||||||
|
# Release v${{ steps.version-bump.outputs.new-version }}
|
||||||
|
|
||||||
|
${{ steps.changelog.outputs.changelog }}
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
**Version Info**: ${{ steps.version-type.outputs.type }} release (v${{ steps.version-bump.outputs.current-version }} → v${{ steps.version-bump.outputs.new-version }})
|
||||||
|
|
||||||
|
### Installation
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install @xtr-dev/payload-mailing@${{ steps.version-bump.outputs.new-version }}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Documentation
|
||||||
|
|
||||||
|
See the [README](https://github.com/xtr-dev/payload-mailing#readme) for usage instructions and full documentation.
|
||||||
|
draft: false
|
||||||
|
prerelease: false
|
||||||
|
|
||||||
|
notify-success:
|
||||||
|
if: github.event_name == 'push' || (github.event.pull_request.merged == true && (contains(github.event.pull_request.head.ref, 'version/major') || contains(github.event.pull_request.head.ref, 'version/minor') || contains(github.event.pull_request.head.ref, 'version/patch')))
|
||||||
|
needs: version-and-publish
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Success notification
|
||||||
|
run: |
|
||||||
|
echo "🎉 Successfully published version ${{ needs.version-and-publish.outputs.new-version }} to NPM!"
|
||||||
|
echo "📦 Package: https://www.npmjs.com/package/@xtr-dev/payload-mailing"
|
||||||
|
echo "🏷️ GitHub Release: https://github.com/xtr-dev/payload-mailing/releases/tag/v${{ needs.version-and-publish.outputs.new-version }}"
|
||||||
127
VERSION_WORKFLOW.md
Normal file
127
VERSION_WORKFLOW.md
Normal file
@@ -0,0 +1,127 @@
|
|||||||
|
# Version Management Workflow
|
||||||
|
|
||||||
|
This repository uses automated version management with GitHub Actions. Version bumps are triggered based on which branch changes are merged to `main`.
|
||||||
|
|
||||||
|
## Available Branches
|
||||||
|
|
||||||
|
- `version/major` - For breaking changes (e.g., 1.0.0 → 2.0.0)
|
||||||
|
- `version/minor` - For new features (e.g., 1.0.0 → 1.1.0)
|
||||||
|
- `version/patch` - For bug fixes (e.g., 1.0.0 → 1.0.1)
|
||||||
|
|
||||||
|
## How to Use
|
||||||
|
|
||||||
|
### For Patch Releases (Bug Fixes)
|
||||||
|
1. Create a branch from `version/patch`:
|
||||||
|
```bash
|
||||||
|
git checkout version/patch
|
||||||
|
git pull origin version/patch
|
||||||
|
git checkout -b fix/your-bug-fix
|
||||||
|
# Make your changes
|
||||||
|
git commit -m "fix: your bug fix description"
|
||||||
|
git push origin fix/your-bug-fix
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Create a PR targeting `version/patch`
|
||||||
|
3. Once approved, merge the PR to `version/patch`
|
||||||
|
4. Create a PR from `version/patch` to `main`
|
||||||
|
5. When merged to `main`, the workflow will:
|
||||||
|
- Bump patch version (e.g., 1.0.0 → 1.0.1)
|
||||||
|
- Run tests and build
|
||||||
|
- Publish to NPM
|
||||||
|
- Create a GitHub release
|
||||||
|
|
||||||
|
### For Minor Releases (New Features)
|
||||||
|
1. Create a branch from `version/minor`:
|
||||||
|
```bash
|
||||||
|
git checkout version/minor
|
||||||
|
git pull origin version/minor
|
||||||
|
git checkout -b feature/your-feature
|
||||||
|
# Make your changes
|
||||||
|
git commit -m "feat: your feature description"
|
||||||
|
git push origin feature/your-feature
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Create a PR targeting `version/minor`
|
||||||
|
3. Once approved, merge the PR to `version/minor`
|
||||||
|
4. Create a PR from `version/minor` to `main`
|
||||||
|
5. When merged to `main`, the workflow will:
|
||||||
|
- Bump minor version (e.g., 1.0.0 → 1.1.0)
|
||||||
|
- Run tests and build
|
||||||
|
- Publish to NPM
|
||||||
|
- Create a GitHub release
|
||||||
|
|
||||||
|
### For Major Releases (Breaking Changes)
|
||||||
|
1. Create a branch from `version/major`:
|
||||||
|
```bash
|
||||||
|
git checkout version/major
|
||||||
|
git pull origin version/major
|
||||||
|
git checkout -b breaking/your-breaking-change
|
||||||
|
# Make your changes
|
||||||
|
git commit -m "feat!: your breaking change description"
|
||||||
|
git push origin breaking/your-breaking-change
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Create a PR targeting `version/major`
|
||||||
|
3. Once approved, merge the PR to `version/major`
|
||||||
|
4. Create a PR from `version/major` to `main`
|
||||||
|
5. When merged to `main`, the workflow will:
|
||||||
|
- Bump major version (e.g., 1.0.0 → 2.0.0)
|
||||||
|
- Run tests and build
|
||||||
|
- Publish to NPM
|
||||||
|
- Create a GitHub release
|
||||||
|
|
||||||
|
## Direct Push to Main
|
||||||
|
Direct pushes to `main` will trigger a patch version bump by default.
|
||||||
|
|
||||||
|
## Required Secrets
|
||||||
|
|
||||||
|
Make sure these secrets are configured in your GitHub repository:
|
||||||
|
|
||||||
|
- `NPM_TOKEN` - Your NPM authentication token for publishing
|
||||||
|
- `GITHUB_TOKEN` - Automatically provided by GitHub Actions
|
||||||
|
|
||||||
|
## Workflow Features
|
||||||
|
|
||||||
|
- ✅ Automatic version bumping based on branch
|
||||||
|
- ✅ AI-generated changelog using Claude Code CLI
|
||||||
|
- ✅ Runs tests before publishing
|
||||||
|
- ✅ Builds the package before publishing
|
||||||
|
- ✅ Creates git tags with changelog in tag message
|
||||||
|
- ✅ Publishes to NPM with public access
|
||||||
|
- ✅ Creates GitHub releases with formatted changelog
|
||||||
|
- ✅ Prevents publishing if tests fail
|
||||||
|
|
||||||
|
## Changelog Generation
|
||||||
|
|
||||||
|
The workflow automatically generates a standardized changelog for each release using Claude Code CLI. The changelog analyzes git commits since the last release and categorizes them into:
|
||||||
|
|
||||||
|
- 🚀 **Features** - New functionality
|
||||||
|
- 🐛 **Bug Fixes** - Bug fixes and corrections
|
||||||
|
- 🔧 **Improvements** - Code improvements and refactoring
|
||||||
|
- 📚 **Documentation** - Documentation updates
|
||||||
|
- ⚡ **Performance** - Performance optimizations
|
||||||
|
|
||||||
|
The generated changelog is included in:
|
||||||
|
- The version bump commit message
|
||||||
|
- The git tag message
|
||||||
|
- The GitHub release notes
|
||||||
|
|
||||||
|
## Version Branch Maintenance
|
||||||
|
|
||||||
|
Keep version branches up to date by periodically merging from main:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git checkout version/patch
|
||||||
|
git merge main
|
||||||
|
git push origin version/patch
|
||||||
|
|
||||||
|
git checkout version/minor
|
||||||
|
git merge main
|
||||||
|
git push origin version/minor
|
||||||
|
|
||||||
|
git checkout version/major
|
||||||
|
git merge main
|
||||||
|
git push origin version/major
|
||||||
|
```
|
||||||
|
|
||||||
|
This ensures that all version branches have the latest changes from main before creating new features or fixes.
|
||||||
Reference in New Issue
Block a user