-
Notifications
You must be signed in to change notification settings - Fork 132
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve the MarkDown render-ability a bit
- Loading branch information
Showing
1 changed file
with
26 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,47 +1,45 @@ | ||
| semantic versioning example | ||
| --------------------------- | ||
| # Semantic versioning example | ||
|
|
||
| bumpversion 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 | ||
| 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 | ||
|
|
||
| ## Details | ||
|
|
||
| Details | ||
| ------- | ||
| Start with an initial release, say `1.0.0`. | ||
|
|
||
| Start with an initial release, say 1.0.0 | ||
| 1. Create a new release, starting with a development build. | ||
|
|
||
| 1. create a new release, starting with a development build | ||
| $ bumpversion patch | ||
| => 1.0.1-dev1 | ||
|
|
||
| $ bumpversion patch | ||
| => 1.0.1-dev1 | ||
| 2. Every time you build, bump `build`. | ||
|
|
||
| 2. every time you build | ||
| $ bumpversion build | ||
| => 1.0.1-dev2 | ||
|
|
||
| $ bumpversion build | ||
| => 1.0.1-dev2 | ||
| 3. Go to release candidate by bumping `release`. | ||
|
|
||
| 3. go to release candidate | ||
| $ bumpversion release | ||
| => 1.0.1-rc1 | ||
|
|
||
| $ bumpversion release | ||
| => 1.0.1-rc1 | ||
| 4. With every new build, bump `build`. | ||
|
|
||
| 4. with every new build | ||
| $ bumpversion build | ||
| => 1.0.1-rc2 | ||
|
|
||
| $ bumpversion build | ||
| => 1.0.1-rc2 | ||
| 4. Finally, bump `release` to generate a final release for the current | ||
| `major` / `minor` / `patch` version. | ||
|
|
||
| 4. final release | ||
| $ bumpversion release | ||
| => 1.0.1 | ||
|
|
||
| $ bumpversion release | ||
| => 1.0.1 | ||
|
|
||
| ## Notes | ||
|
|
||
| Notes | ||
| ----- | ||
|
|
||
| * once the final release has been reached it is not possible to bump the release | ||
| before bumping patch again. Trying to bump the release while in final release state will | ||
| issue "ValueError: The part has already the maximum value among ['dev', 'rc', 'ga'] and cannot be bumped" | ||
| * Once the final release has been reached, it is not possible to bump | ||
| the `release` before bumping `patch` again. Trying to bump the release | ||
| while in final release state will issue | ||
| `ValueError: The part has already the maximum value among ['dev', 'rc', 'ga'] and cannot be bumped`. | ||
|
|