1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
Box Hatter
==========
Box Hatter is continuous integration server/executor. It provides isolated
execution environments, for running automated actions, as containers managed
by podman.
Key features:
* automated projects based on git repositories
* containers as execution runners
* per project configuration as YAML file inside project's repository
* web based control and monitoring interface (without JavaScript)
* webhook/periodic execution triggering
* CLI executor
Runtime requirements
--------------------
* python >=3.8
* git
* podman
Install
-------
::
$ pip install boxhatter
Running
-------
Box Hatter enables execution of actions described by simple YAML files which
contain container image name and Posix shell execution script. Actions files
are stored as part of git repositories (default name of action file is
`.boxhatter.yaml`, stored in root of git working tree).
These actions can be executed with::
$ boxhatter execute <path>
where ``<path>`` is path to git repository containing action definition.
Referenced git repository can be local or remote.
Additionally, Box Hatter can be run as daemon providing web server interface::
$ boxhatter server
When run as server, Box Hatter periodically lists configured git repository
references, and schedules action executions if new commits are available.
New commit checking can also be triggered by webhooks available at listening
`/repo/<repo_name>/webhook` URL path (``<repo_name>`` is configured repository
name).
Box Hatter server provides basic web GUI which can be used for monitoring
action executions and scheduling new executions based on user provided
git reference.
Action and server configurations are defined and documented by JSON schemas
`schemas_json/action.yaml`_ and `schemas_json/server.yaml`_.
For additional options, see::
$ boxhatter --help
Configuration example
---------------------
* `.boxhatter.yaml`
::
image: alpine
command: |
echo "hello $WHO"
* `server.yaml`
::
repos:
example:
url: path/to/example/repository
env:
WHO: world
Build
-----
Build tool used for Box Hatter is pydoit (`<http://pydoit.org>`_). It can be
installed together with other python dependencies by running::
$ pip install -r requirements.pip.dev.txt
For listing available doit tasks, use::
$ doit list
Default task::
$ doit
creates `build` folder containing Box Hatter distribution.
License
-------
boxhatter - continuous integration server/executor
Copyright (C) 2017-2022 Bozo Kopic
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
