Skip to content

Commit

Permalink
Merge pull request #88 from jatcwang/master
Browse files Browse the repository at this point in the history
Add FAQ for skipping binary compatibility check for major version branches
  • Loading branch information
dwijnand committed Feb 9, 2019
2 parents f9db36e + 8f71ca0 commit fa0c86d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Expand Up @@ -154,6 +154,15 @@ This will return an error message like the following:

* `git`, on the `PATH`

## FAQ

### How do I make previousStableVersion return None for major version branches?

Deciding whether going from one version to another is a "breaking change" is out of scope for this project.
If you have binary compatibility check setup using `previousStableVersion` in CI
and want to skip the check for major version branches (e.g. `1.x` vs `2.x`), see https://github.com/dwijnand/sbt-dynver/issues/70#issuecomment-458620722
for the recommended solution.

## Licence

Copyright 2016-2017 Dale Wijnand
Expand Down

0 comments on commit fa0c86d

Please sign in to comment.