Improve semantic versioning table #2974
Conversation
Try to add a simplier table about semantic versioning upgrade. Base on docker#2869
| |:----|:---|:------------|----------| | ||
| | x.y.z | x+1.a.b | major upgrade | yes | | ||
| | x.y.z-1 | x+1.a.b+1 | major upgrade from an old version | no | | ||
| | x.y.z | x+1.a+1.b | major upgrade skipping minor version | no | |
There was a problem hiding this comment.
I like it, but I think that you need to do a lot of thinking when looking at table two. I think we can make it easier by moving the Description column to be the first one.
The notation with a and b is also interesting but it introduces a lot of complexity. Since the first minor and patch versions are always 0, you can do
| From | To | Description | Supported |
|---|---|---|---|
| x.y.z | x+1.0.0 | major upgrade | yes |
| x.y.z | x+1.y+1.z | major upgrade, skipping minor version | no |
The case for "major upgrade from an old version" is a bit special and few users are running that configuration, so we can leave it out.
I think this is a good compromise between accuracy and simplicity. #SimpleDocsFTW
There was a problem hiding this comment.
Yeah, I already remove some line because when I read it, it was complicated for me too.
Thanks for your eyes!
|
@joaofnfernandes ready for a new review! |
| | skip major version | x.*.* | x+2.*.* | no | | ||
| | major downgrade | x.*.* | x-1.*.* | no | | ||
|
|
||
| In the next table, y and z are the latest minor or patch version and a,b the |
There was a problem hiding this comment.
Since we're not using a and b you can remove this sentence, and make this a single table again. After that and padding the table, we're ready to ship.
Pro tip: if you're using Atom, there's this markdown-table-formatter that automatically fixes tables when you save.
There was a problem hiding this comment.
I check if we have the same kind of plugin for vscode, thanks for the protip!
|
@mstanleyjones and @joaofnfernandes ready for a new review :) |
|
I don't see anything here that would make the build break, and was seeing some errors with the Netlify APIs. Kicking it off again to see if the works this time. |
4 participants
Proposed changes
Try to add a simplier table about semantic versioning upgrade.
Base on #2869
Related issues (optional)
Fix #2285