document new release and versioning process #10336
Conversation
There was a problem hiding this comment.
I think since most visitors to this page probably care more about what major, minor, and patch mean in the context of electron, instead of what they mean in general, the Overview of Semantic Versioning section isn't as relevant as the rest of this document. Perhaps we can consider removing that section altogether, or at least move it under Electron Versioning and Prereleases?
|
Hey @vanessayuenn and @malept I made some updates based on your feedback. Let me know what you think. |
|
@vanessayuenn the new "distribution tags" section looks good to me. |
|
Thank you so much for putting so much care into Electron and outlining this for Electron users. ❤️ |
docs/tutorial/electron-versioning.md
Outdated
|
|
||
| A `dist-tag` can be used when installing Electron as a reference to a version instead of using a specific version number: | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Thanks, @TiagoDanin. Fixed.
zeke
changed the title
zeke
changed the title
zeke
force-pushed
the
document-prereleases
branch
from
1939d82 to
44572dc
Compare
zeke
changed the title
|
Okay I've brought in @Tyriar's changes (thanks) and made some updates. This is now ready to go pending review from @tonyganch, @jkleinsc, and @vanessayuenn |
docs/tutorial/electron-versioning.md
Outdated
| | Electron breaking API change | Major | ||
| | Electron non-breaking API change | Minor | ||
| | Electron bug fix | Patch | ||
| | Anything sufficiently "risky"\* | Major |
There was a problem hiding this comment.
Was the note removed defined what risky meant (\*)? I can't see it.
|
@simurai if you have a spare moment to electronify that versions graphic, that would be 👌 |
|
One small thing with the info displayed on the svg: beta versions actually have to start with 1, to adhere to the window |
|
I updated the documentation on the release process to reflect what I imagine the new process would be like, though I am sure crucial information is currently still missing from it. We can improve upon it after we have done the first release following the new versioning policy. |
|
Thanks for updating |
This PR is an attempt to document our new (as of yet unused) strategy for doing pre-release versions of Electron. This content is optimistically projecting that we'll start using this approach with 1.8.0.