[libvirt PATCH v2] docs: introduce a page showing a overall CI dashboard
With the move to GitLab CI one of the things we miss from Jenkins is a single page dashboard showing CI status across all projects. This is a very simple replacement that uses badges for CI pipeline status. Signed-off-by: Daniel P. Berrangé <berrange@redhat.com> --- docs/ci.rst | 230 ++++++++++++++++++++++++++++++++++++++++++++++ docs/docs.html.in | 3 + docs/libvirt.css | 5 + 3 files changed, 238 insertions(+) create mode 100644 docs/ci.rst diff --git a/docs/ci.rst b/docs/ci.rst new file mode 100644 index 0000000000..fe59b98923 --- /dev/null +++ b/docs/ci.rst @@ -0,0 +1,230 @@ +============================== +Libvirt Continuous Integration +============================== + +.. contents:: + +The libvirt project primarily uses GitLab CI for automated testing of Linux +builds, and cross-compiled Windows builds. `Travis <https://travis-ci.org/libvirt/libvirt>`_ +is used for validating macOS builds, and `Jenkins <https://ci.centos.org/view/libvirt>`_ +is temporarily used for validating FreeBSD builds. + +GitLab CI Dashboard +=================== + +The dashboard below shows the current status of the GitLab CI jobs for each +repository: + +Core project +------------ + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + + * - libvirt + - .. image:: https://gitlab.com/libvirt/libvirt/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt/pipelines + :alt: libvirt pipeline status + + +Language bindings +----------------- + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + + * - libvirt-csharp + - .. image:: https://gitlab.com/libvirt/libvirt-csharp/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-csharp/pipelines + :alt: libvirt-csharp pipeline status + + * - libvirt-go + - .. image:: https://gitlab.com/libvirt/libvirt-go/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-go/pipelines + :alt: libvirt-go pipeline status + + * - libvirt-java + - .. image:: https://gitlab.com/libvirt/libvirt-java/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-java/pipelines + :alt: libvirt-java pipeline status + + * - libvirt-ocaml + - .. image:: https://gitlab.com/libvirt/libvirt-ocaml/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-ocaml/pipelines + :alt: libvirt-ocaml pipeline status + + * - libvirt-perl + - .. image:: https://gitlab.com/libvirt/libvirt-perl/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-perl/pipelines + :alt: libvirt-perl pipeline status + + * - libvirt-php + - .. image:: https://gitlab.com/libvirt/libvirt-php/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-php/pipelines + :alt: libvirt-php pipeline status + + * - libvirt-python + - .. image:: https://gitlab.com/libvirt/libvirt-python/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-python/pipelines + :alt: libvirt-python pipeline status + + * - libvirt-rust + - .. image:: https://gitlab.com/libvirt/libvirt-rust/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-rust/pipelines + :alt: libvirt-rust pipeline status + + * - ruby-libvirt + - .. image:: https://gitlab.com/libvirt/ruby-libvirt/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/ruby-libvirt/pipelines + :alt: ruby-libvirt pipeline status + + +Object mappings +--------------- + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + + * - libvirt-cim + - .. image:: https://gitlab.com/libvirt/libvirt-cim/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-cim/pipelines + :alt: libvirt-cim pipeline status + + * - libvirt-dbus + - .. image:: https://gitlab.com/libvirt/libvirt-dbus/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-dbus/pipelines + :alt: libvirt-dbus pipeline status + + * - libvirt-glib + - .. image:: https://gitlab.com/libvirt/libvirt-glib/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-glib/pipelines + :alt: libvirt-glib pipeline status + + * - libvirt-go-xml + - .. image:: https://gitlab.com/libvirt/libvirt-go-xml/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-go-xml/pipelines + :alt: libvirt-go-xml pipeline status + + * - libvirt-snmp + - .. image:: https://gitlab.com/libvirt/libvirt-snmp/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-snmp/pipelines + :alt: libvirt-snmp pipeline status + + +Testing +------- + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + + * - libvirt-ci + - .. image:: https://gitlab.com/libvirt/libvirt-ci/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-ci/pipelines + :alt: libvirt-ci pipeline status + + * - libvirt-dockerfiles + - .. image:: https://gitlab.com/libvirt/libvirt-dockerfiles/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-dockerfiles/pipelines + :alt: libvirt-dockerfiles pipeline status + + * - libvirt-test-API + - .. image:: https://gitlab.com/libvirt/libvirt-test-API/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-test-API/pipelines + :alt: libvirt-test-API pipeline status + + * - libvirt-tck + - .. image:: https://gitlab.com/libvirt/libvirt-tck/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-tck/pipelines + :alt: libvirt-tck pipeline status + + +Documentation / websites +------------------------ + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + * - libvirt-publican + - .. image:: https://gitlab.com/libvirt/libvirt-publican/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-publican/pipelines + :alt: libvirt-publican pipeline status + + * - libvirt-appdev-guide-python + - .. image:: https://gitlab.com/libvirt/libvirt-appdev-guide-python/badges/master/pipelin... + :target: https://gitlab.com/libvirt/libvirt-appdev-guide-python/pipelines + :alt: libvirt-appdev-guide-python pipeline status + + * - libvirt-wiki + - .. image:: https://gitlab.com/libvirt/libvirt-wiki/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-wiki/pipelines + :alt: libvirt-wiki pipeline status + + * - virttools-planet + - .. image:: https://gitlab.com/libvirt/virttools-planet/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/virttools-planet/pipelines + :alt: virttools-planet pipeline status + + * - virttools-web + - .. image:: https://gitlab.com/libvirt/virttools-web/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/virttools-web/pipelines + :alt: virttools-web pipeline status + + +Miscellaneous +------------- + +.. list-table:: + :widths: 80 20 + :header-rows: 1 + + * - Project + - Pipeline + + * - libvirt-console-proxy + - .. image:: https://gitlab.com/libvirt/libvirt-console-proxy/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-console-proxy/pipelines + :alt: libvirt-console-proxy pipeline status + + * - libvirt-designer + - .. image:: https://gitlab.com/libvirt/libvirt-designer/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-designer/pipelines + :alt: libvirt-designer pipeline status + + * - libvirt-devaddr + - .. image:: https://gitlab.com/libvirt/libvirt-devaddr/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-devaddr/pipelines + :alt: libvirt-devaddr pipeline status + + * - libvirt-sandbox + - .. image:: https://gitlab.com/libvirt/libvirt-sandbox/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-sandbox/pipelines + :alt: libvirt-sandbox pipeline status + + * - libvirt-sandbox-image + - .. image:: https://gitlab.com/libvirt/libvirt-sandbox-image/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/libvirt-sandbox-image/pipelines + :alt: libvirt-sandbox-image pipeline status + + * - libvirt-security-notice + - .. image:: https://gitlab.com/libvirt/libvirt-security-notice/badges/master/pipeline.sv... + :target: https://gitlab.com/libvirt/libvirt-security-notice/pipelines + :alt: libvirt-security-notice pipeline status diff --git a/docs/docs.html.in b/docs/docs.html.in index 6bdf0c32b8..f1d44fadc0 100644 --- a/docs/docs.html.in +++ b/docs/docs.html.in @@ -142,6 +142,9 @@ <dt><a href="strategy.html">Project strategy</a></dt> <dd>Sets a vision for future direction & technical choices</dd> + <dt><a href="ci.html">CI Testing</a></dt> + <dd>Details of the Continuous Integration testing strategy</dd> + <dt><a href="bugs.html">Bug reports</a></dt> <dd>How and where to report bugs and request features</dd> diff --git a/docs/libvirt.css b/docs/libvirt.css index 94d0b9058c..a2c9778e03 100644 --- a/docs/libvirt.css +++ b/docs/libvirt.css @@ -592,3 +592,8 @@ td.gitmirror { td.gitmirror a { color: inherit; } + +th p, td p { + margin-top: 0px; + margin-bottom: 0px; +} -- 2.26.2
On Thu, 2020-05-07 at 15:29 +0100, Daniel P. Berrangé wrote:
+ * - ruby-libvirt + - .. image:: https://gitlab.com/libvirt/ruby-libvirt/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/ruby-libvirt/pipelines + :alt: ruby-libvirt pipeline status
Seriously though, why is this one not called libvirt-ruby? :)
+++ b/docs/libvirt.css @@ -592,3 +592,8 @@ td.gitmirror { td.gitmirror a { color: inherit; } + +th p, td p { + margin-top: 0px; + margin-bottom: 0px; +}
This hunk is unrelated and should go in a separate patch. For both this patch and the one with the CSS fix, Reviewed-by: Andrea Bolognani <abologna@redhat.com> -- Andrea Bolognani / Red Hat / Virtualization
On Thu, May 07, 2020 at 07:08:52PM +0200, Andrea Bolognani wrote:
On Thu, 2020-05-07 at 15:29 +0100, Daniel P. Berrangé wrote:
+ * - ruby-libvirt + - .. image:: https://gitlab.com/libvirt/ruby-libvirt/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/ruby-libvirt/pipelines + :alt: ruby-libvirt pipeline status
Seriously though, why is this one not called libvirt-ruby? :)
I'd consider it mostly a historical accident. The actual tarball created is ruby-libvirt-$VER.tar.gz, so the repo follows that. For the perl though, we're call perl-Sys-Virt-$VER.tar.gz, but the repo is libvirt-perl. I've almost renamed the Ruby repo on a number of occassions but never went through with it.
+++ b/docs/libvirt.css @@ -592,3 +592,8 @@ td.gitmirror { td.gitmirror a { color: inherit; } + +th p, td p { + margin-top: 0px; + margin-bottom: 0px; +}
This hunk is unrelated and should go in a separate patch.
It *is* related, because without this the tables in this new page get rendered which huge whitespace gaps, due to rst putting a <p> tag inside each cell.
For both this patch and the one with the CSS fix,
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
Regards, Daniel -- |: https://berrange.com -o- https://www.flickr.com/photos/dberrange :| |: https://libvirt.org -o- https://fstop138.berrange.com :| |: https://entangle-photo.org -o- https://www.instagram.com/dberrange :|
On Mon, 2020-05-11 at 10:49 +0100, Daniel P. Berrangé wrote:
On Thu, May 07, 2020 at 07:08:52PM +0200, Andrea Bolognani wrote:
On Thu, 2020-05-07 at 15:29 +0100, Daniel P. Berrangé wrote:
+ * - ruby-libvirt + - .. image:: https://gitlab.com/libvirt/ruby-libvirt/badges/master/pipeline.svg + :target: https://gitlab.com/libvirt/ruby-libvirt/pipelines + :alt: ruby-libvirt pipeline status
Seriously though, why is this one not called libvirt-ruby? :)
I'd consider it mostly a historical accident. The actual tarball created is ruby-libvirt-$VER.tar.gz, so the repo follows that.
For the perl though, we're call perl-Sys-Virt-$VER.tar.gz, but the repo is libvirt-perl.
I've almost renamed the Ruby repo on a number of occassions but never went through with it.
I'd say the move to GitLab is as good an excluse as any :) Can we make it happen?
+ +th p, td p { + margin-top: 0px; + margin-bottom: 0px; +}
This hunk is unrelated and should go in a separate patch.
It *is* related, because without this the tables in this new page get rendered which huge whitespace gaps, due to rst putting a <p> tag inside each cell.
I know, but we already have reStructuredText-generated tables in our documentation, all of which exhibit the layout issue you describe. So it should be its own patch, which you can merge before this one. -- Andrea Bolognani / Red Hat / Virtualization
participants (2)
-
Andrea Bolognani -
Daniel P. Berrangé