search

c4urself / bump2version

Version-bump your software with a single command
https://pypi.python.org/pypi/bump2version
MIT License
1.06k stars 134 forks source link

adding semantic version example #177

Closed miraculixx closed 3 years ago

miraculixx commented 3 years ago

This adds an example that implements the semantic versioning flow

1.0.0 => 1.0.1-dev1 => 1.0.1-dev2 = > 1.0.1-rc1 => 1.0.1-rc2 => 1.0.1
         patch         build          release      build        release

credits to @jeremycarroll who provided the crucial ideas

florisla commented 3 years ago

Looks good to me!

This introduces an examples folder. I think that makes sense -- the README is way too long as it is already. I think in due time we should put some documentation up on ReadTheDocs.org.

I prefer adding this to /docs/examples/semantic instead of /examples/semantic .

c4urself commented 3 years ago

Yeah I really like the examples idea, I'd been thinking of doing something similar like an examples directory for various use-cases.

florisla commented 3 years ago

Hi, could you merge my proposed changes into your branch?

miraculixx commented 3 years ago

Done @florisla https://github.com/c4urself/bump2version/pull/177#issuecomment-757020860