GitHub action to be applied on merged pull-request, to bump a semver and create a new release. Optionally, it can also bump version on changelog and package.json/version.txt
The best explanation is by example. Please have a look at this project's pr.yml file
to see how this project is dogfooding the action in order to bump-release itself.
Out of the box, this action will always bump your release with a patch, unless configured to do otherwise. This action can decide what part of the SemVer so increment depending on the way it's configured. Additionally and optionally, it can update your package.json/version.txt and/or changelog.md with the updated version.
If provided with bump: <patch | minor | major> or < fix | feat | breaking > as input it will use this input to bump and ignore any other configuration.
If provided with infer_bump_from_commit: true as input it will try to guess the right one depending on the commit message. Right now the logic is a commit header that starts with the words 'patch', 'minor' or 'major'.
Please refer to action.yml in this repository to see all available options.
If you need more features, please submit an issue or a pull request.
- Modify/add whatever you need from
index.ts - npm run build
- Add, commit and push your commits to a different branch
- Invoke this action with your branch --> uses: ultimateai/bump-action@{Your_branch}
This action was born for satisfy specifically Ultimate's needs, with particular mention to file update, not only release bumping. It can be made more customizable to adapt to future needs.