How to register breaking changes?

General Usage
,
1

I made some breaking changes to one of my package and consequently incremented the version number of 0.1 instead of 0.0.1, but this is not recognized as such by the bot so now my pull request has to be merged manually. What did I do wrong?

2 
 1.1.2 skips over 1.1.0

https://github.com/johncwok/CategoricalTimeSeries.jl/blob/99dbdea6bb4856fb28ca83225cf1a4a3ec065599/Project.toml#L5

breaking change will need to be 1.1.0 or 2.0.0 since right now you have:
https://github.com/JuliaRegistries/General/blob/cd4ed715220eb43ce526a94a64728e5c954014af/C/CategoricalTimeSeries/Versions.toml#L7

3

Can I just modify the project.toml to 1.1.0 and create another pull request or will this create issues?

4

yes, fix it and re-tag the bot

5

Thanks, this worked. 1.1.0 was tagged as a minor release though, is this normal?

6

read SemVer. If you want to signify it is super breaking, just register 2.0.0.

7

If you have version X.Y.Z with X>0, then

  • Step Z if your change is backwards compatible and doesn’t add new features. This is typically bugfixes, performance improvements and documentation changes. It’s called a patch release.
  • Step Y if your change is backwards compatible and adds new features. This is called a minor release.
  • Step X if your change is not backwards compatible, i.e. breaks existing code. This is called a major release or a breaking release.

All concepts of features and backwards compatibility is with respect to a public API, which you may or may not have defined explicitly.

1 Like
8

What should imo be added here is that stepping anything but the last part of the version number sets all lower parts to 0.

E.g.

  • 1.1.2 becomes 1.2.0 when stepping the minor version
  • 1.2.0 becomes 2.0.0 when stepping the major version.
1 Like