Bump diff compares exact pull request changes only

This new release mostly includes a bugfix on the automated diff feature on pull requests.

🐛 Bug fix

• The automatic bump diff action will now only compare the exact changes made in your pull request, by ignoring any merge commit (GitHub automatically runs any Github-Action on a merge commit between your PR and your target branch), and checking the last common ancestor between your target branch and your PR head branch. This is hopefully the last bugfix around diff management in our github-action. Sorry to those of you who have been (patiently) sharing their issues, and especially @gmourier from Meilisearch 🙏

✨

v1.0.4

🆙 Upgrades

• Upgrade bump-cli to latest v2.2.5 in order to accept AsyncAPI files up to specification version 2.2

✨

Bump diff now compares the pull request changes

This new release mostly includes a bugfix on the automated diff feature on pull requests.

🐛 Bug fix

• The automatic bump diff (if used in your repository) action will now only compare the changes present in your pull requests instead of comparing with the latest deployed version of your documentation on bump.sh. This means the github bot comment will include a comprehensive, and consistent, summary of the API changes made in your pull request.

  You might not have seen this bug if you use a single main branch and merge PRs often. But if you had a “buffering” git branch (usually a staging branch for instance) you probably saw inconsistent API changelogs in some of the bot comments. This is now over and diff comparison will present only API changes made in your pull request 😌🎉.

✨

🆙 Upgrades

• Typescript dependency has been updated from 4.3 to 4.4

Notify breaking changes on bump diff more explicitly

This new release mostly includes a small bugfix on the GitHub automated diff comments on PRs.

🐛 Bug fix

• The bot comment on pull requests warning about the diff of your API will now be more explicit in case of breaking changes (🚨).

🆙 Upgrades

• There were a few libraries upgrades since last release thanks to @dependabot
• Minimal node version supported by the action is now v12

✨

Always update bot comment on PRs

Check our blog post announcement talking about our new api diff feature if you missed our v1.0.0 release

This new release mostly includes a small bugfix on the GitHub automated diff comments on PRs.

🐛 Bug fix

• The bot comment will now be updated every time there is a change in the resulting documentation (and not only on structural changes).

🆙 Upgrades

• There were a few libraries upgrades since last release thanks to @dependabot.

✨

@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 a github-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#1

  

  It'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.

⚠️ The old 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