Differential D886

Update formula file names in docs
ClosedPublic
Actions

Authored by mkrizek on Jun 9 2016, 12:01 PM.

Details

Reviewers
jskladan
Group Reviewers
libtaskotron
Commits
rLTRNb95773c388fc: Update formula file names in docs
Test Plan

.

Diff Detail

Repository
rLTRN libtaskotron
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
mkrizek retitled this revision from to Update formula file names in docs.Jun 9 2016, 12:01 PM
mkrizek updated this object.
mkrizek edited the test plan for this revision. (Show Details)
mkrizek added a reviewer: libtaskotron.
jskladan accepted this revision.Jun 9 2016, 1:00 PM
jskladan added a reviewer: jskladan.
This revision is now accepted and ready to land.Jun 9 2016, 1:00 PM
Closed by commit rLTRNb95773c388fc: Update formula file names in docs (authored by mkrizek). · Explain WhyJun 13 2016, 8:55 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathPackages
Mdocs/source/index.rst (4 lines)
Mdocs/source/quickstart.rst (2 lines)
Mreadme.rst (6 lines)

Diff 2271

View Options

docs/source/index.rst

Show First 20 Lines • Show All 121 Lines • ▼ Show 20 Line(s)
122============= 122​=============
123 123​
124Using `rpmlint <https://bitbucket.org/fedoraqa/task-rpmlint>`_ as an example, 124​Using `rpmlint <https://bitbucket.org/fedoraqa/task-rpmlint>`_ as an example,
125the task repository contains the following:: 125​the task repository contains the following::
126 126​
127 task-rpmlint/ 127​ task-rpmlint/
128 readme.rst 128​ readme.rst
129 rpmlint.py 129​ rpmlint.py
130 rpmlint.yml 130​ runtask.yml
131 131​
132Rpmlint runs off of koji builds, so to run it against the x86_64 build of 132​Rpmlint runs off of koji builds, so to run it against the x86_64 build of
133``foo-1.2-3.fc99`` (substitute a real build if you're going to run this):: 133​``foo-1.2-3.fc99`` (substitute a real build if you're going to run this)::
134 134​
135 runtask -i foo-1.2-3.fc99 -t koji_build -a x86_64 rpmlint.yml 135​ runtask -i foo-1.2-3.fc99 -t koji_build -a x86_64 runtask.yml
136 136​
137The build will be downloaded to a local tempdir, rpmlint will be run against 137​The build will be downloaded to a local tempdir, rpmlint will be run against
138that build and the results will be printed to the console in :ref:`resultyaml-format`. 138​that build and the results will be printed to the console in :ref:`resultyaml-format`.
139 139​
140Using Remote Machines 140​Using Remote Machines
141---------------------- 141​----------------------
142 142​
143While the default execution path will run tasks on a local machine, it is also 143​While the default execution path will run tasks on a local machine, it is also
Show All 31 Lines
View Options

docs/source/quickstart.rst

Show First 20 Lines • Show All 83 Lines • ▼ Show 20 Line(s)
84`Rpmlint <https://bitbucket.org/fedoraqa/task-rpmlint>`_ 84​`Rpmlint <https://bitbucket.org/fedoraqa/task-rpmlint>`_
85 85​
86:: 86​::
87 87​
88 git clone https://bitbucket.org/fedoraqa/task-rpmlint.git 88​ git clone https://bitbucket.org/fedoraqa/task-rpmlint.git
89 89​
90:: 90​::
91 91​
92 runtask -i gourmet-0.16.0-2.fc20 -t koji_build -a x86_64 task-rpmlint/rpmlint.yml 92​ runtask -i gourmet-0.16.0-2.fc20 -t koji_build -a x86_64 task-rpmlint/runtask.yml
93 93​
94 94​
95Other Examples 95​Other Examples
96-------------- 96​--------------
97 97​
98 98​
99`Rpmbuild <https://bitbucket.org/fedoraqa/task-rpmbuild>`_ 99​`Rpmbuild <https://bitbucket.org/fedoraqa/task-rpmbuild>`_
100 100​
101`Example bodhi <https://bitbucket.org/fedoraqa/task-examplebodhi>`_ 101​`Example bodhi <https://bitbucket.org/fedoraqa/task-examplebodhi>`_
102 102​
103`Example reporting <https://bitbucket.org/fedoraqa/task-example_reporting>`_ 103​`Example reporting <https://bitbucket.org/fedoraqa/task-example_reporting>`_
104 104​
105Check `our git <https://bitbucket.org/fedoraqa>`_ for more. 105​Check `our git <https://bitbucket.org/fedoraqa>`_ for more.
View Options

readme.rst

Show First 20 Lines • Show All 123 Lines • ▼ Show 20 Line(s)
124The task requires the rpmlint tool to be installed, so be sure to run:: 124​The task requires the rpmlint tool to be installed, so be sure to run::
125 125​
126 sudo yum install rpmlint 126​ sudo yum install rpmlint
127 127​
128To run that task against a koji build with NEVR ``<nevr>`` for some arch 128​To run that task against a koji build with NEVR ``<nevr>`` for some arch
129``<arch>``, do the following:: 129​``<arch>``, do the following::
130 130​
131 git clone https://bitbucket.org/fedoraqa/task-rpmlint.git 131​ git clone https://bitbucket.org/fedoraqa/task-rpmlint.git
132 runtask -i <nevr> -t koji_build -a <arch> task-rpmlint/rpmlint.yml 132​ runtask -i <nevr> -t koji_build -a <arch> task-rpmlint/runtask.yml
133 133​
134This will download the ``<nevr>`` from koji into a temp directory under 134​This will download the ``<nevr>`` from koji into a temp directory under
135``/var/tmp/``, run rpmlint on the downloaded rpms and print output in YAML format 135​``/var/tmp/``, run rpmlint on the downloaded rpms and print output in YAML format
136to stdout. 136​to stdout.
137 137​
138Example:: 138​Example::
139 139​
140 runtask -i xchat-2.8.8-21.fc20 -t koji_build -a x86_64 task-rpmlint/rpmlint.yml 140​ runtask -i xchat-2.8.8-21.fc20 -t koji_build -a x86_64 task-rpmlint/runtask.yml
141 141​
142 142​
143Using Disposable Clients for Task Execution 143​Using Disposable Clients for Task Execution
144=========================================== 144​===========================================
145 145​
146When executing the task on the local machine is not desirable, you can use the 146​When executing the task on the local machine is not desirable, you can use the
147disposable client feature - a new virtual machine is spawned from a base image 147​disposable client feature - a new virtual machine is spawned from a base image
148and the task is executed in the VM. 148​and the task is executed in the VM.
149 149​
150Note: you need to setup Testcloud first refer to `Setting up Testcloud`_ 150​Note: you need to setup Testcloud first refer to `Setting up Testcloud`_
151 151​
152To use the feature, just add ``--libvirt`` parameter ot the runtask command:: 152​To use the feature, just add ``--libvirt`` parameter ot the runtask command::
153 153​
154 runtask --libvirt -i xchat-2.8.8-21.fc20 -t koji_build -a x86_64 task-rpmlint/rpmlint.yml 154​ runtask --libvirt -i xchat-2.8.8-21.fc20 -t koji_build -a x86_64 task-rpmlint/runtask.yml
155 155​
156By default, a base image defined by the ``imageurl`` option in ``taskotron.yaml`` 156​By default, a base image defined by the ``imageurl`` option in ``taskotron.yaml``
157config file is used. You can provide your own base image by changing the 157​config file is used. You can provide your own base image by changing the
158``imageurl`` value (use ``file://`` URL to point to a local file). 158​``imageurl`` value (use ``file://`` URL to point to a local file).
159 159​
160We also provide `updated base images at <https://tflink.fedorapeople.org/taskotron/taskotron-cloud/images/>_` 160​We also provide `updated base images at <https://tflink.fedorapeople.org/taskotron/taskotron-cloud/images/>_`
161(note that the image needs to be uncompressed before use). 161​(note that the image needs to be uncompressed before use).
162 162​
▲ Show 20 Lines • Show All 98 Lines • Show Last 20 Lines