| Message ID | 20220330182424.3438872-11-jsnow@redhat.com |
|---|---|
| State | New |
| Headers | show |
| Series | python: fork qemu.qmp python lib into independent repo | expand |
On 3/30/22 20:24, John Snow wrote: > The package is in an alpha state, but there's a method to the madness. > > Signed-off-by: John Snow <jsnow@redhat.com> > --- > README.rst | 21 +++++++++++++++++++++ > 1 file changed, 21 insertions(+) > > diff --git a/README.rst b/README.rst > index 8593259..88efe84 100644 > --- a/README.rst > +++ b/README.rst > @@ -154,6 +154,27 @@ fail. These checks use their own virtual environments and won't pollute > your working space. > > > +Stability and Versioning > +------------------------ > + > +This package uses a major.minor.micro SemVer versioning, with the > +following additional semantics during the alpha/beta period (Major > +version 0): > + > +This package treats 0.0.z versions as "alpha" versions. Each micro > +version update may change the API incompatibly. Early users are advised > +to pin against explicit versions, but check for updates often. > + > +A planned 0.1.z version will introduce the first "beta", whereafter each > +micro update will be backwards compatible, but each minor update will > +not be. The first beta version will be released after legacy.py is > +removed, and the API is tentatively "stable". > + > +Thereafter, normal SemVer/PEP440 rules will apply; micro updates will > +always be bugfixes, and minor updates will be reserved for backwards > +compatible feature changes. > + > + > Changelog > --------- > Looks reasonable to me. Reviewed-by: Damien Hedde <damien.hedde@greensocs.com>
On Tue, Apr 5, 2022, 5:16 AM Damien Hedde <damien.hedde@greensocs.com> wrote: > > > On 3/30/22 20:24, John Snow wrote: > > The package is in an alpha state, but there's a method to the madness. > > > > Signed-off-by: John Snow <jsnow@redhat.com> > > --- > > README.rst | 21 +++++++++++++++++++++ > > 1 file changed, 21 insertions(+) > > > > diff --git a/README.rst b/README.rst > > index 8593259..88efe84 100644 > > --- a/README.rst > > +++ b/README.rst > > @@ -154,6 +154,27 @@ fail. These checks use their own virtual > environments and won't pollute > > your working space. > > > > > > +Stability and Versioning > > +------------------------ > > + > > +This package uses a major.minor.micro SemVer versioning, with the > > +following additional semantics during the alpha/beta period (Major > > +version 0): > > + > > +This package treats 0.0.z versions as "alpha" versions. Each micro > > +version update may change the API incompatibly. Early users are advised > > +to pin against explicit versions, but check for updates often. > > + > > +A planned 0.1.z version will introduce the first "beta", whereafter each > > +micro update will be backwards compatible, but each minor update will > > +not be. The first beta version will be released after legacy.py is > > +removed, and the API is tentatively "stable". > > + > > +Thereafter, normal SemVer/PEP440 rules will apply; micro updates will > > +always be bugfixes, and minor updates will be reserved for backwards > > +compatible feature changes. > > + > > + > > Changelog > > --------- > > > > Looks reasonable to me. > Reviewed-by: Damien Hedde <damien.hedde@greensocs.com> > Thanks! I'm hoping to make it easier to spin up more dev tooling outside of the qemu tree. If you've got any wishlist items, feel free to let me know. It's still early days for Python packages outside of the qemu tree, so nearly everything is on the table still. (the jsnow/python staging branch has some 17 patches in it that will be checked in to QEMU when development re-opens. The forked qemu.qmp repo will be based off of qemu.git after those patches go in. There's a bit of shakeup where I delete the old qmp lib and replace it with what's currently aqmp. It should hopefully not be a huge nuisance to your work, but if there's issues, let me know.) Thanks, --John Snow
diff --git a/README.rst b/README.rst index 8593259..88efe84 100644 --- a/README.rst +++ b/README.rst @@ -154,6 +154,27 @@ fail. These checks use their own virtual environments and won't pollute your working space. +Stability and Versioning +------------------------ + +This package uses a major.minor.micro SemVer versioning, with the +following additional semantics during the alpha/beta period (Major +version 0): + +This package treats 0.0.z versions as "alpha" versions. Each micro +version update may change the API incompatibly. Early users are advised +to pin against explicit versions, but check for updates often. + +A planned 0.1.z version will introduce the first "beta", whereafter each +micro update will be backwards compatible, but each minor update will +not be. The first beta version will be released after legacy.py is +removed, and the API is tentatively "stable". + +Thereafter, normal SemVer/PEP440 rules will apply; micro updates will +always be bugfixes, and minor updates will be reserved for backwards +compatible feature changes. + + Changelog ---------
The package is in an alpha state, but there's a method to the madness. Signed-off-by: John Snow <jsnow@redhat.com> --- README.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+)