@aquaron/vdeploy
v0.2.0
Published
Manage deployment, changelog, and version
Downloads
7
Maintainers
Readme
@aquaron/vdeploy
Automate versioning (and changelogs) when a release is created.
Use
$ vdeploy
That's it! It'll walk you through the setup process the first time.
You will need to edit .github/workflows/vdeploy.yml
to match your release process.
See this package's vdeploy.yml to get an idea how to set one up for your project.
Process
- Install the
vdeploy.yml
andincr-version.sh
in the right places - Checks for outstanding PR and merge them (requires GitHub CLI)
- Update
CHANGELOG.md
from commit log (you can editable, vim) - Create a release with the next version number as tag and title (editable)
Files
.github/workflows/vdeploy.yml
When a release is created:
- Triggers deployment workflow (see the file)
- Increment
package.json
's minorversion
- Create a PR of the modified
package.json
.github/scripts/incr-version.sh
Increment the version number minor based on what was just released.