Skip to content

Commit

Permalink
docs: document special behavior of auto bumps on 0.y.z
Browse files Browse the repository at this point in the history
  • Loading branch information
tranzystorekk authored and oknozor committed Oct 11, 2020
1 parent 67a736c commit 6fb5ec5
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,11 @@ Note that if your project already contains a changelog you can tell `cog` about
- - -
```

You might also need to adjust `changelog_path` in `cog.toml`.
You might also need to adjust `changelog_path` in `cog.toml`.

**Note:** `cog bump --auto` treats `0.y.z` versions specially,
i.e. it will never do an auto bump to the `1.0.0` version, even if there are breaking changes.
That way, you can keep adding features in the development stage and decide yourself, when your API is stable.

## Bump hooks

Expand Down

0 comments on commit 6fb5ec5

Please sign in to comment.