Differential D849

Add documention on dist-git tasks
ClosedPublic
Actions

Authored by mkrizek on May 12 2016, 4:13 PM.

Details

Reviewers

tflink

Group Reviewers

libtaskotron

Commits

rLTRN81e0efba6d52: Add documention on dist-git tasks

Summary

SSIA. @tflink, please translate into English, if needed :)

Test Plan

doit builddocs, read :)

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 Add documention on dist-git tasks.May 12 2016, 4:13 PM

mkrizek updated this object.

mkrizek edited the test plan for this revision. (Show Details)

mkrizek added a reviewer: libtaskotron.

mkrizek added a subscriber: tflink.

A few nits but overall, looks good. Thanks for taking care of this so quickly

docs/source/distgittasks.rst
12	Can you put something in here like "if you run into issues, let us know so we can fix them"?
17	wouldn't 'push to dist-git' be more accurate? Not sure if I'm being overly pedantic here, though

This revision is now accepted and ready to land.May 12 2016, 4:19 PM

Closed by commit rLTRN81e0efba6d52: Add documention on dist-git tasks (authored by mkrizek). · Explain WhyMay 12 2016, 4:36 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents

			Path	Packages
A	M		docs/source/distgittasks.rst (46 lines)
M			docs/source/index.rst (1 line)

Diff	ID	Base	Description	Created	Lint	Unit
Base			Base
Diff 1	2180	ef22cdf		May 12 2016, 4:13 PM	★	★
Diff 2	2181	ef22cdf	rLTRN81e0efba6d5291c4eb451ff3108c8b0a4f64cc33	May 12 2016, 4:35 PM	★	★

Commit	Tree	Parents	Author	Summary	Date
45f004a7f7d0	ccaaf6855483	ef22cdf0dbf9	Martin Krizek	Add documention on dist-git tasks (Show More…)	May 12 2016, 4:08 PM

Diff 2181

View Options

docs/source/distgittasks.rst

This file was added.

1		.. _dist-git-tasks:
2
3		===============
4		Dist-git tasks
5		===============
6
7		How to have a taskotron task run from dist-git
8		==============================================
9
10		.. note::
11		The feature is new and rough edges are expected. If you run into issues, please let us know so
12		we can fix them.
	tflinkUnsubmitted Not Done Can you put something in here like "if you run into issues, let us know so we can fix them"?
13
14		Once the task is written (see :ref:`writing-tasks-for-taskotron`), it can be pushed into
15		`dist-git <http://pkgs.fedoraproject.org/cgit/rpms-checks>`_ and be run on different actions.
16		Currently, only action supported is 'run the task on build completion in koji'. This is going to
17		change in the near future and actions like 'push to dist-git' or 'upload to look-aside cache' will
	tflinkUnsubmitted Not Done wouldn't 'push to dist-git' be more accurate? Not sure if I'm being overly pedantic here, though
18		be supported as well. Taskotron determines on what action to run a particular task according to
19		the ``input`` section in the formula, in this case on koji build completion.
20
21		.. code-block:: yaml
22
23		---
24		name: mytask
25		desc: do something stupendous
26		maintainer: somefasuser
27
28		input:
29		args:
30		- arch
31		- koji_build
32
33		Note that the formula yaml file must be named ``runtask.yml``. Taskotron tasks dist-git works the
34		same way as the dist-git for Fedora packages but it is located in a different
35		`namespace <http://pkgs.fedoraproject.org/cgit/rpms-checks>`_. Each tasks must be in a separate
36		directory in the repo. Branches work the same way as rpms dist-git as well, so tasks for Fedora 24
37		will be in the ``f24`` branch and so on. Example of the directory structure of the repo follows:
38
39		::
40
41		\|-- sanity_check
42		\| \|-- sanity_check.py
43		\| \-- runtask.yml
44		\-- services_test
45		\|-- services_test.sh
46		\-- runtask.yml