7:58 a.m.
Hi,
just bit summary of few changes in ovirt-engine-sdk repo [1]. There was the
decision to split the SDK generator and the python SDK itself. So we
created a new repository on GitHub called python-ovirt-engine-sdk4 [2].
We switched from Travis CI to GitHub Actions, because Travis no
longer supported .org domain where we had our tests. The GitHub Actions
automatically builds the SDK and pushes it to the new repo similar to the
Go SDK.
There were some issues with the documentation generator [3] so we
switched to the new version of pdoc [4].
We migrated the SDK examples because the examples have nothing to do with
the generator itself moved it to the new repository [6].
Martin Necas
[1] https://github.com/ovirt/ovirt-engine-sdk
[2] https://github.com/ovirt/python-ovirt-engine-sdk4
[3] http://ovirt.github.io/ovirt-engine-sdk/master/
[4] https://pdoc.dev/docs/pdoc.html
[5] https://gerrit.ovirt.org/#/c/ovirt-engine-sdk/+/116066/
[6] https://github.com/oVirt/python-ovirt-engine-sdk4/tree/main/examples
8:51 a.m.
On Mon, Aug 9, 2021 at 4:05 PM Martin Necas <mnecas(a)redhat.com> wrote:
just bit summary of few changes in ovirt-engine-sdk repo [1]. There
was the decision to split the SDK generator and the python SDK itself. So we created a new
repository on GitHub called python-ovirt-engine-sdk4 [2].
We switched from Travis CI to GitHub Actions, because Travis no longer supported .org
domain where we had our tests. The GitHub Actions automatically builds the SDK and pushes
it to the new repo similar to the Go SDK.
There were some issues with the documentation generator [3] so we switched to the new
version of pdoc [4].
We migrated the SDK examples because the examples have nothing to do with the generator
itself moved it to the new repository [6].
The examples and the generator are different parts of the python sdk. Why
do we need to add another repository? We already have too many repositories.
With this change we lose all the history from the sdk examples, and we
break all the links to the example scripts. Try this search:
https://www.google.co.il/search?q=upload_disk.py
Why was this not discussed here before the change?
Nir
9:03 a.m.
On Mon, Aug 9, 2021 at 3:52 PM Nir Soffer <nsoffer(a)redhat.com> wrote:
On Mon, Aug 9, 2021 at 4:05 PM Martin Necas <mnecas(a)redhat.com>
wrote:
> just bit summary of few changes in ovirt-engine-sdk repo [1]. There was
the decision to split the SDK generator and the python SDK itself. So we
created a new repository on GitHub called python-ovirt-engine-sdk4 [2].
>
> We switched from Travis CI to GitHub Actions, because Travis no longer
supported .org domain where we had our tests. The GitHub Actions
automatically builds the SDK and pushes it to the new repo similar to the
Go SDK.
>
> There were some issues with the documentation generator [3] so we
switched to the new version of pdoc [4].
>
> We migrated the SDK examples because the examples have nothing to do
with the generator itself moved it to the new repository [6].
The examples and the generator are different parts of the python sdk. Why
do we need to add another repository? We already have too many
repositories.
We needed to split the current SDK to allow easier build and packaging of
the Python part. Because the generator part depends on many Java packages,
building it for different platforms (for example for CentOS Stream 9)
requires huge amounts of resources. Separating Python part allows us easy
Python build for different Python version and probably it will allow us to
add SDK into EPEL, which would simplify using it as a dependency for other
projects (for example oVirt Ansible Collection)
With this change we lose all the history from the sdk examples, and
we
break all the links to the example scripts. Try this search:
https://www.google.co.il/search?q=upload_disk.py
If really needed we can add some README to current generator repo, but the
most important link, which is official documentation, hasn't changed:
http://ovirt.github.io/ovirt-engine-sdk/4.4/
Not to mention that finally after solving lots of issues with documentation
generation it's up-to-date and aligned with SDK releases.
And I really need to raise it again:
EXAMPLES IN PYTHON SDK SHOULD NOT BE USED AS PRODUCTION READY TOOLS AND
THAT'S WHY THERE IS NO HARM IN MOVING THEM TO DIFFERENT REPOSITORY.
Why was this not discussed here before the change?
It was discussed between all maintainers of SDK.
Nir
--
Martin Perina
Manager, Software Engineering
Red Hat Czech s.r.o.
1203
days inactive
1203
days old
2 comments
3 participants
participants (3)
-
Martin Necas -
Martin Perina -
Nir Soffer