The documentation is not very extensive, plus the documented commands don't really work anymore now that the guests/ directory has been added. Move to Markdown while at it, since it's a much nicer format than whatever ad-hoc pseudo-markup we're using now.
Signed-off-by: Andrea Bolognani <abolo...@redhat.com> --- README | 34 ---------------------------------- README.markdown | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 34 deletions(-) delete mode 100644 README create mode 100644 README.markdown diff --git a/README b/README deleted file mode 100644 index 9871cfc..0000000 --- a/README +++ /dev/null @@ -1,34 +0,0 @@ - Libvirt Jenkins CI - ================== - -This package contains the libvirt Jenkins CI configuration tasks. - -This uses the jenkins job builder tool which can be installed - - $ pip install --user jenkins-job-builder - -The jobs/ directory contains general templates for defining -jobs for the different build systems (autotools, python distutils, -perl ExtUtils::MakeMaker, etc) - -The projects/ directory contains the per-project config which -activates the desired jobs and configures them if needed. - -It is possible to see the raw jenkins configuration using - - $ jenkins-jobs test -r . libvirt-glib-build - -Before updating the jobs on the server a file is needed to provide -the login details - - $ cat jenkins_jobs.ini - [jenkins] - user=XXX - password=XXX - url=https://ci.centos.org - - -To update the jenkins server with all jobs - - $ jenkins-jobs --conf jenkins_jobs.ini update -r . - diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..391b970 --- /dev/null +++ b/README.markdown @@ -0,0 +1,48 @@ +Libvirt Jenkins CI +================== + +This repository contains jobs definitions for the libvirt Jenkins CI. + +They're supposed to be fed to the Jenkins Job Builder tool, which can +be installed either through your distribution's package manager, for +example using: + + # dnf install python3-jenkins-job-builder + +on Fedora, or straight from pip using: + + $ pip install --user jenkins-job-builder + +The `jobs/` directory contains general templates for defining jobs +for the different build systems, such as GNU `autotools`, Python's +`distutils`, Perl's `ExtUtils::MakeMaker` and so on. + +The `projects/` directory contains the per-project config which +activates the desired jobs and configures them if needed. + +It's possible to see the raw Jenkins configuration using either: + + $ jenkins-jobs test -x .git -x guests -r . + +to see al jobs, or: + + $ jenkins-jobs test -x .git -x guests -r . libvirt-master-build + +if you're interested in a single job. + +In order to apply the updated configuration on the server, you're +going to need a configuration file containing access information: + + $ cat jenkins.ini + [jenkins] + user=XXX + password=XXX + url=https://ci.centos.org + +To update the Jenkins server with all jobs, run: + + $ jenkins-jobs --conf jenkins.ini update -x .git -x guests -r . + +The `guests/` directory contains tools used to manage the CI guests +rather than the Jenkins server; they are documented separately in +`guests/README.markdown`. -- 2.13.6 -- libvir-list mailing list libvir-list@redhat.com https://www.redhat.com/mailman/listinfo/libvir-list
