Differential D721

Document environment section of formulas
ClosedPublic
Actions

Authored by mkrizek on Jan 13 2016, 12:45 PM.

Details

Reviewers
kparal
tflink
jskladan
Maniphest Tasks
T681: document environment section of libtaskotron formulas
Commits
rLTRN4301f9681af3: Document environment section of formulas
Summary

Fixes T681

Test Plan

doit builddocs

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 Document environment section of formulas.Jan 13 2016, 12:45 PM
mkrizek updated this object.
mkrizek edited the test plan for this revision. (Show Details)
mkrizek added reviewers: tflink, kparal, jskladan.
mkrizek added a task: T681: document environment section of libtaskotron formulas.
kparal accepted this revision.Jan 13 2016, 3:58 PM
kparal added inline comments.
docs/source/taskyaml.rst
67–69

We should probably add that we support anything that dnf install supports as an argument on the command line.

This revision is now accepted and ready to land.Jan 13 2016, 3:58 PM
tflink accepted this revision.Jan 14 2016, 6:28 AM
Closed by commit rLTRN4301f9681af3: Document environment section of formulas (authored by mkrizek). · Explain WhyJan 14 2016, 8:43 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

Diff 1853

View Options

docs/source/quickstart.rst

Show First 20 Lines • Show All 42 Lines • ▼ Show 20 Line(s)38.. code-block:: yaml
43 43​
44 input: 44​ input:
45 args: 45​ args:
46 - arg1 # supported args: 46​ - arg1 # supported args:
47 - arg2 # arch, koji_build, bodhi_id, koji_tag 47​ - arg2 # arch, koji_build, bodhi_id, koji_tag
48 48​
49 environment: 49​ environment:
50 rpm: 50​ rpm:
51 - dependency1 # not checked in current version 51​ - dependency1 # libtaskotron installs these when in production or --local mode,
52 - dependency2 # only for human reference 52​ - dependency2 # otherwise users are expected to install them on libtaskotron machine
53 53​
54 actions: 54​ actions:
55 - name: pick fluxweed on a full moon 55​ - name: pick fluxweed on a full moon
56 directivename: # e.g. koji, bodhi, python, ... 56​ directivename: # e.g. koji, bodhi, python, ...
57 arg1: value1 57​ arg1: value1
58 arg2: ${some_variable} # e.g. input arg 58​ arg2: ${some_variable} # e.g. input arg
59 export: firststep_output # export usable as input arg of next directive 59​ export: firststep_output # export usable as input arg of next directive
60 60​
Show All 35 Lines
View Options

docs/source/taskyaml.rst

Show First 20 Lines • Show All 58 Lines • ▼ Show 20 Line(s)57Valid args include:
59 * arch (e.g.: ``x86_64``, ``[i386, x86_64]``) 59​ * arch (e.g.: ``x86_64``, ``[i386, x86_64]``)
60 * koji_build (e.g.: ``xchat-0:2.8.8-19.fc19``, ``xchat-2.8.8-19.fc19``) 60​ * koji_build (e.g.: ``xchat-0:2.8.8-19.fc19``, ``xchat-2.8.8-19.fc19``)
61 * bodhi_id (e.g.: ``FEDORA-2013-10476``, ``xchat-2.8.8-19.fc19``) 61​ * bodhi_id (e.g.: ``FEDORA-2013-10476``, ``xchat-2.8.8-19.fc19``)
62 * koji_tag (e.g.: ``f20-updates-testing-pending``) 62​ * koji_tag (e.g.: ``f20-updates-testing-pending``)
63 63​
64Dependencies 64​Dependencies
65------------ 65​------------
66 66​
67A task may also require the presence of other code to support execution. Those 67​A task may also require the presence of other code to support execution. Those
68dependencies are specified as part of the environment description. 68​dependencies are specified as part of the environment description. Anything that
69​``dnf install`` supports as an argument on the command line is supported.
kparalUnsubmitted
Not Done

We should probably add that we support anything that dnf install supports as an argument on the command line.

69 70​
70.. code-block:: yaml 71​.. code-block:: yaml
71 72​
72 environment: 73​ environment:
73 rpm: 74​ rpm:
74 - rpmlint 75​ - python-solv
75 - libtaskotron 76​ - python-librepo
76 ​
77.. note:: ​
78 ​
79 At this time, the list of rpm dependencies is not checked during execution ​
80 but this will change in future versions. For now, this section is ignored and ​
81 is mostly for human reference. ​
82 77​
83.. note:: 78​.. note::
84 79​
85 Future versions will also support specifying dependencies in other formats 80​ Future versions will also support specifying dependencies in other formats
86 than RPM. 81​ than RPM.
87 82​
88 83​
89Task Execution 84​Task Execution
▲ Show 20 Lines • Show All 148 Lines • Show Last 20 Lines
View Options

docs/source/writingtasks.rst

Show First 20 Lines • Show All 76 Lines • ▼ Show 20 Line(s)76.. note::
77 77​
78 Taskotron was designed to work with tasks stored in git repositories and 78​ Taskotron was designed to work with tasks stored in git repositories and
79 while this is not strictly required for the local execution case, it is 79​ while this is not strictly required for the local execution case, it is
80 highly recommended that you limit tasks to one per directory. 80​ highly recommended that you limit tasks to one per directory.
81 81​
82Non-Executed Task Information 82​Non-Executed Task Information
83----------------------------- 83​-----------------------------
84 84​
85For this example, let's write a task that runs on bodhi ids. Looking at the 85​For this example, let's write a task that runs on bodhi IDs. Looking at the
86non-executed task data needed in :file:`mytask.yml`: 86​non-executed task data needed in :file:`mytask.yml`:
87 87​
88.. code-block:: yaml 88​.. code-block:: yaml
89 89​
90 --- 90​ ---
91 name: mytask 91​ name: mytask
92 desc: do something stupendous 92​ desc: do something stupendous
93 maintainer: somefasuser 93​ maintainer: somefasuser
94 94​
95 input: 95​ input:
96 args: 96​ args:
97 - arch 97​ - arch
98 - bodhi_id 98​ - bodhi_id
99 99​
100 environment: 100​ environment:
101 rpm: 101​ rpm:
102 - libtaskotron 102​ - rpm_that_task_uses
103 103​
104 104​
105Executed Task Information 105​Executed Task Information
106------------------------- 106​-------------------------
107 107​
108Let's have this new task do the following: 108​Let's have this new task do the following:
109 109​
110 * download the rpms contained in the indicated bodhi update 110​ * download the rpms contained in the indicated bodhi update
▲ Show 20 Lines • Show All 209 Lines • Show Last 20 Lines