feat: Add automatic semantic versioning workflow
- Create GitHub Actions workflow for automatic version bumping based on PR title prefixes - Add version bumping script (scripts/bump_version.py) for programmatic updates - Update PR template with semantic versioning guidelines - Document versioning workflow in contributing guide - Integrate with existing Docker build workflow via git tags This enables automatic version management: - feat: triggers MINOR version bump - fix: triggers PATCH version bump - breaking: triggers MAJOR version bump - docs/chore/test: no version bump 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Patryk Ciechanski
137
.github/pull_request_template.md
vendored
137
.github/pull_request_template.md
vendored
@@ -1,116 +1,49 @@
|
||||
<!--
|
||||
Thank you for your contribution to the Gemini MCP Server!
|
||||
Please provide a clear description of your changes and ensure all requirements are met.
|
||||
-->
|
||||
## PR Title Format
|
||||
|
||||
## Related Issue
|
||||
**Please ensure your PR title follows one of these formats:**
|
||||
|
||||
<!-- Link to the issue that this PR addresses -->
|
||||
<!-- e.g., "Closes #123" or "Fixes #456" -->
|
||||
<!-- If no issue exists, please consider creating one first to discuss the change -->
|
||||
|
||||
Closes #
|
||||
|
||||
## Type of Change
|
||||
|
||||
<!--
|
||||
Please check the relevant box with [x]
|
||||
-->
|
||||
|
||||
- [ ] 🐞 Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] ✨ New feature (non-breaking change which adds functionality)
|
||||
- [ ] 🛠️ New Gemini tool (adds a new tool like `chat`, `codereview`, etc.)
|
||||
- [ ] 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
- [ ] 📖 Documentation update
|
||||
- [ ] 🧹 Refactor or chore (no user-facing changes)
|
||||
- [ ] 🏗️ Infrastructure/CI changes
|
||||
- `feat: <description>` - New features (triggers MINOR version bump)
|
||||
- `fix: <description>` - Bug fixes (triggers PATCH version bump)
|
||||
- `breaking: <description>` or `BREAKING CHANGE: <description>` - Breaking changes (triggers MAJOR version bump)
|
||||
- `perf: <description>` - Performance improvements (triggers PATCH version bump)
|
||||
- `refactor: <description>` - Code refactoring (triggers PATCH version bump)
|
||||
- `docs: <description>` - Documentation only (no version bump)
|
||||
- `chore: <description>` - Maintenance tasks (no version bump)
|
||||
- `test: <description>` - Test additions/changes (no version bump)
|
||||
- `ci: <description>` - CI/CD changes (no version bump)
|
||||
- `style: <description>` - Code style changes (no version bump)
|
||||
|
||||
## Description
|
||||
|
||||
<!--
|
||||
A clear and concise description of the changes.
|
||||
- **What** is the change?
|
||||
- **Why** is this change necessary?
|
||||
- **How** does it address the issue?
|
||||
-->
|
||||
Please provide a clear and concise description of what this PR does.
|
||||
|
||||
## Changes Made
|
||||
|
||||
- [ ] List the specific changes made
|
||||
- [ ] Include any breaking changes
|
||||
- [ ] Note any dependencies added/removed
|
||||
|
||||
## Testing
|
||||
|
||||
<!--
|
||||
The project has high testing standards. Please describe the tests you have added or updated.
|
||||
Both unit tests (no API key) and live integration tests (with API key) are important.
|
||||
-->
|
||||
- [ ] Unit tests pass
|
||||
- [ ] Integration tests pass (if applicable)
|
||||
- [ ] Manual testing completed
|
||||
- [ ] Documentation updated (if needed)
|
||||
|
||||
### Unit Tests (Required)
|
||||
- [ ] I have added new unit tests to cover my changes
|
||||
- [ ] I have run `python -m pytest tests/ --ignore=tests/test_live_integration.py -v` and all tests pass
|
||||
- [ ] New tests use proper mocking and don't require API keys
|
||||
## Related Issues
|
||||
|
||||
### Live Integration Tests (Recommended)
|
||||
- [ ] I have tested this with a real Gemini API key using `python tests/test_live_integration.py`
|
||||
- [ ] The changes work as expected with actual API calls
|
||||
- [ ] I have tested this on [macOS/Linux/Windows (WSL2)]
|
||||
Fixes #(issue number)
|
||||
|
||||
### Docker Testing (If Applicable)
|
||||
- [ ] I have tested the Docker build: `docker build -t test-image .`
|
||||
- [ ] I have tested the Docker functionality: `./setup-docker.sh`
|
||||
- [ ] Docker integration works with the changes
|
||||
## Checklist
|
||||
|
||||
## Code Quality
|
||||
- [ ] PR title follows the format guidelines above
|
||||
- [ ] Code follows the project's style guidelines
|
||||
- [ ] Self-review completed
|
||||
- [ ] Tests added/updated as needed
|
||||
- [ ] Documentation updated as needed
|
||||
- [ ] All tests passing
|
||||
- [ ] Ready for review
|
||||
|
||||
<!--
|
||||
Please confirm you've followed the project's quality standards
|
||||
-->
|
||||
## Additional Notes
|
||||
|
||||
- [ ] My code follows the project's style guidelines (`black .` and `ruff check .`)
|
||||
- [ ] I have run the linting tools and fixed any issues
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] My changes generate no new warnings
|
||||
- [ ] I have updated type hints where applicable
|
||||
|
||||
## Documentation
|
||||
|
||||
<!--
|
||||
Documentation should be updated to reflect any user-facing changes
|
||||
-->
|
||||
|
||||
- [ ] I have made corresponding changes to the documentation
|
||||
- [ ] I have updated the README.md if my changes affect usage
|
||||
- [ ] I have updated CONTRIBUTING.md if my changes affect the development workflow
|
||||
- [ ] For new tools: I have added usage examples and parameter documentation
|
||||
|
||||
## Breaking Changes
|
||||
|
||||
<!--
|
||||
If this is a breaking change, please describe what breaks and how users should adapt
|
||||
-->
|
||||
|
||||
- [ ] This change is backwards compatible
|
||||
- [ ] OR: I have documented the breaking changes and migration path below
|
||||
|
||||
<!--
|
||||
If breaking changes, describe them here:
|
||||
-->
|
||||
|
||||
## Additional Context
|
||||
|
||||
<!--
|
||||
Add any other context about the pull request here, such as:
|
||||
- Performance implications
|
||||
- Security considerations
|
||||
- Future improvements this enables
|
||||
- Screenshots (for UI changes)
|
||||
- Related PRs or issues
|
||||
-->
|
||||
|
||||
## Checklist for Maintainers
|
||||
|
||||
<!--
|
||||
This section is for maintainers to check during review
|
||||
-->
|
||||
|
||||
- [ ] Code review completed
|
||||
- [ ] All CI checks passing
|
||||
- [ ] Breaking changes properly documented
|
||||
- [ ] Version bump needed (if applicable)
|
||||
- [ ] Documentation updated and accurate
|
||||
Any additional information that reviewers should know.
|
||||
168
.github/workflows/auto-version.yml
vendored
Normal file
168
.github/workflows/auto-version.yml
vendored
Normal file
@@ -0,0 +1,168 @@
|
||||
name: Auto Version
|
||||
|
||||
on:
|
||||
pull_request:
|
||||
types: [closed]
|
||||
branches: [main]
|
||||
|
||||
jobs:
|
||||
version:
|
||||
# Only run if PR was merged (not just closed)
|
||||
if: github.event.pull_request.merged == true
|
||||
runs-on: ubuntu-latest
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: read
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Setup Python
|
||||
uses: actions/setup-python@v4
|
||||
with:
|
||||
python-version: '3.9'
|
||||
|
||||
- name: Configure git
|
||||
run: |
|
||||
git config user.name "github-actions[bot]"
|
||||
git config user.email "github-actions[bot]@users.noreply.github.com"
|
||||
|
||||
- name: Determine version bump type
|
||||
id: bump_type
|
||||
run: |
|
||||
PR_TITLE="${{ github.event.pull_request.title }}"
|
||||
echo "PR Title: $PR_TITLE"
|
||||
|
||||
# Convert to lowercase for case-insensitive matching
|
||||
PR_TITLE_LOWER=$(echo "$PR_TITLE" | tr '[:upper:]' '[:lower:]')
|
||||
|
||||
# Determine bump type based on PR title prefix
|
||||
if [[ "$PR_TITLE_LOWER" =~ ^(breaking|breaking[[:space:]]change): ]]; then
|
||||
echo "Detected BREAKING CHANGE - major version bump"
|
||||
echo "bump_type=major" >> $GITHUB_OUTPUT
|
||||
echo "should_bump=true" >> $GITHUB_OUTPUT
|
||||
elif [[ "$PR_TITLE_LOWER" =~ ^feat: ]]; then
|
||||
echo "Detected new feature - minor version bump"
|
||||
echo "bump_type=minor" >> $GITHUB_OUTPUT
|
||||
echo "should_bump=true" >> $GITHUB_OUTPUT
|
||||
elif [[ "$PR_TITLE_LOWER" =~ ^(fix|perf|refactor): ]]; then
|
||||
echo "Detected fix/perf/refactor - patch version bump"
|
||||
echo "bump_type=patch" >> $GITHUB_OUTPUT
|
||||
echo "should_bump=true" >> $GITHUB_OUTPUT
|
||||
elif [[ "$PR_TITLE_LOWER" =~ ^(docs|chore|test|ci|style): ]]; then
|
||||
echo "Detected non-versioned change - no version bump"
|
||||
echo "bump_type=none" >> $GITHUB_OUTPUT
|
||||
echo "should_bump=false" >> $GITHUB_OUTPUT
|
||||
else:
|
||||
echo "No recognized prefix - no version bump"
|
||||
echo "bump_type=none" >> $GITHUB_OUTPUT
|
||||
echo "should_bump=false" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
|
||||
- name: Get current version
|
||||
if: steps.bump_type.outputs.should_bump == 'true'
|
||||
id: current_version
|
||||
run: |
|
||||
CURRENT_VERSION=$(python -c "from config import __version__; print(__version__)")
|
||||
echo "Current version: $CURRENT_VERSION"
|
||||
echo "version=$CURRENT_VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Bump version
|
||||
if: steps.bump_type.outputs.should_bump == 'true'
|
||||
id: new_version
|
||||
run: |
|
||||
python scripts/bump_version.py ${{ steps.bump_type.outputs.bump_type }}
|
||||
NEW_VERSION=$(python -c "from config import __version__; print(__version__)")
|
||||
echo "New version: $NEW_VERSION"
|
||||
echo "version=$NEW_VERSION" >> $GITHUB_OUTPUT
|
||||
|
||||
- name: Commit version change
|
||||
if: steps.bump_type.outputs.should_bump == 'true'
|
||||
run: |
|
||||
git add config.py
|
||||
git commit -m "chore: bump version to ${{ steps.new_version.outputs.version }}
|
||||
|
||||
Automated version bump from PR #${{ github.event.pull_request.number }}
|
||||
${{ github.event.pull_request.title }}
|
||||
|
||||
Co-authored-by: ${{ github.event.pull_request.user.login }} <${{ github.event.pull_request.user.id }}+${{ github.event.pull_request.user.login }}@users.noreply.github.com>"
|
||||
git push
|
||||
|
||||
- name: Create git tag
|
||||
if: steps.bump_type.outputs.should_bump == 'true'
|
||||
run: |
|
||||
git tag -a "v${{ steps.new_version.outputs.version }}" -m "Release v${{ steps.new_version.outputs.version }}
|
||||
|
||||
Changes in this release:
|
||||
- ${{ github.event.pull_request.title }}
|
||||
|
||||
PR: #${{ github.event.pull_request.number }}
|
||||
Author: @${{ github.event.pull_request.user.login }}"
|
||||
git push origin "v${{ steps.new_version.outputs.version }}"
|
||||
|
||||
- name: Generate release notes
|
||||
if: steps.bump_type.outputs.should_bump == 'true'
|
||||
id: release_notes
|
||||
run: |
|
||||
# Extract PR body for release notes
|
||||
PR_BODY=$(cat << 'EOF'
|
||||
${{ github.event.pull_request.body }}
|
||||
EOF
|
||||
)
|
||||
|
||||
# Create release notes
|
||||
RELEASE_NOTES=$(cat << EOF
|
||||
## What's Changed
|
||||
|
||||
${{ github.event.pull_request.title }} by @${{ github.event.pull_request.user.login }} in #${{ github.event.pull_request.number }}
|
||||
|
||||
### Details
|
||||
|
||||
$PR_BODY
|
||||
|
||||
### Version Info
|
||||
- Previous version: ${{ steps.current_version.outputs.version }}
|
||||
- New version: ${{ steps.new_version.outputs.version }}
|
||||
- Bump type: ${{ steps.bump_type.outputs.bump_type }}
|
||||
|
||||
**Full Changelog**: https://github.com/${{ github.repository }}/compare/v${{ steps.current_version.outputs.version }}...v${{ steps.new_version.outputs.version }}
|
||||
EOF
|
||||
)
|
||||
|
||||
# Save to file for GitHub release
|
||||
echo "$RELEASE_NOTES" > release_notes.md
|
||||
|
||||
- name: Create GitHub release
|
||||
if: steps.bump_type.outputs.should_bump == 'true'
|
||||
uses: softprops/action-gh-release@v1
|
||||
with:
|
||||
tag_name: v${{ steps.new_version.outputs.version }}
|
||||
name: Release v${{ steps.new_version.outputs.version }}
|
||||
body_path: release_notes.md
|
||||
draft: false
|
||||
prerelease: false
|
||||
generate_release_notes: true
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
||||
- name: Summary
|
||||
run: |
|
||||
if [ "${{ steps.bump_type.outputs.should_bump }}" == "true" ]; then
|
||||
echo "### ✅ Version Bumped Successfully" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Previous version**: ${{ steps.current_version.outputs.version }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **New version**: ${{ steps.new_version.outputs.version }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Bump type**: ${{ steps.bump_type.outputs.bump_type }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Tag**: v${{ steps.new_version.outputs.version }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **PR**: #${{ github.event.pull_request.number }}" >> $GITHUB_STEP_SUMMARY
|
||||
else
|
||||
echo "### ℹ️ No Version Bump Required" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "PR title prefix did not require a version bump." >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **PR**: #${{ github.event.pull_request.number }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Title**: ${{ github.event.pull_request.title }}" >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
Reference in New Issue
Block a user