# Getting Started
# Why Beachball?
beachball helps streamline this process. As developers make PRs, it helps track the types and details of changes being made. Then when it's time to publish a new version,
beachball automates publishing version bumps to npm, generating changelogs, and syncing changes back to the git repo.
# Beachball workflow
beachball fits into your workflow without any extra configuration (by default).
For the workflow, a
picture diagram is worth a thousand words, so here it is:
Inner loop: When you've made some commits to your branch, simply run
beachball change to generate change files.
Pull request: The PR build runs
beachball check to verify change files are included. Your colleagues can review the change file description and type, and easily propose changes if needed. The PR with change files then gets merged to the target branch (e.g.
- All change files are deleted
- Versions are bumped, checked in locally and pushed remotely
- npm packages are published to a public or private registry
At that point, your repo is ready for the next change!