Releases: bump-sh/github-action
@v1 stable release including API diff comments on PRs
Check our blog post announcement talking about our new api diff
feature
Stable version @v1
is out 🚀
This is the first stable v1 version of our Bump Github Action. It was crafted with love to integrate smoothly in your development workflow, whether you have API documentation needs or API changelog needs or both!
What's new? 🆕
-
You can now use the
bump-sh/github-action@v1
v1 tag inside your workflow yaml definition. This tag will follow the v1.x minor releases which we will update with only minor changes/bug fixes, no breaking changes expected. By doing so you won't have to follow every minor updates we do regularly and can be sure to always have the most up-to-date github-action code running in your Actions. -
Our github-action now offers a new
command: diff
input parameter, which can help you detect API changes before they land in production during your code review. This is done directly as agithub-action[bot]
comment on your pull requests. Here is an example taken from the OpenAPI specification of the Gitlab API: bump-sh/gitlab-api-example#1It's a perfect new reviewer bot to help you detect API changes (and soon breaking changes 🙂).
Internals 🛠️
We have updated many node dependencies to use the latest available packages, re-wrote the way we import our bump-cli
package inside the github-action to have a better programmatic interaction. See this PR on the CLI side if you are interested.
Use new bump-cli 2.0.1
This release is a complete re-write of the existing Bump github-action to use the codebase of the new Bump CLI. It uses typescript to directly interact with Bump.sh.
validate
value for the command
input is being deprecated in favor of the value dry-run
. The keyword validate
will continue to work for this version but will be removed in the next releases.
Use bump-cli 0.7
- update bump-cli to use the latest (0.7) version
- fix this version when running the
gem install
to be sure that we control it
Initial release
0.1 Update README version