PackBumpPR v1: Simplify Your Package Version Management 🚀
We’re excited to announce the first release of PackBumpPR, a GitHub Action designed to make package version management effortless! 🎉
Highlights ✨
- Manual Trigger: Use GitHub's
workflow_dispatchto bump versions anytime, anywhere—even on your phone! 📱 - Flexible Versioning: Supports
patch,minor,major, and custom version increments for maximum control. - Automated Pull Requests: Automatically creates a pull request with your version bump, saving you time.
- Dependabot Collaboration: Seamlessly integrates with Dependabot to keep your dependencies and versions in sync.
- Portable and Lightweight: Requires no local setup—just drop it in your workflows.
Key Features 🔑
- Update both
package.jsonandpackage-lock.jsonwith your new version. - Push changes to a dedicated branch.
- Automatically open a pull request targeting your main branch.
- Fully customizable inputs to fit your workflow:
version_increment: Choose the type of version bump (patch,minor,major, orcustom).custom_version: Provide a custom version number.github_token: Authenticate for GitHub Actions.main_branche: Specify your main branch (e.g.,mainormaster).
Requirements ✅
jqandnpx semverfor JSON manipulation and version incrementing.- GitHub Actions must have write permissions to push changes and create pull requests.
Example Workflow 💻
name: Dispatchable Version Bump
on:
workflow_dispatch:
inputs:
version_increment:
description: "Version increment type (patch, minor, major, or custom)"
required: true
default: "patch"
custom_version:
description: "Custom version (only if version_increment is custom)"
required: false
jobs:
bump-version:
runs-on: ubuntu-latest
steps:
- name: Use PackBumpPR
uses: HichemTab-tech/PackBumpPR@v1
with:
version_increment: ${{ github.event.inputs.version_increment }}
custom_version: ${{ github.event.inputs.custom_version }}
github_token: ${{ secrets.GITHUB_TOKEN }}
main_branche: "main"Known Issues 🐞
- None reported! 🎉 Please report any issues via GitHub Issues.
What’s Next? 🚀
We’re planning to add:
- Better logging and debugging options.
- Support for additional package managers.
- Enhanced error handling.
We hope you enjoy using PackBumpPR! Your feedback and contributions are welcome. Let’s make package versioning effortless together! 💪✨