README.md 1.93 KB
Newer Older
Brandon Fairchild's avatar
Brandon Fairchild committed
1
# Debian Continuous Integration
2 3

The [Debian continuous integration](..) (debci) is an automated system that
Antonio Terceiro's avatar
Antonio Terceiro committed
4
coordinates the execution of automated tests against packages in the
5
[Debian](https://www.debian.org/) system. `debci` will continuously run
Antonio Terceiro's avatar
Antonio Terceiro committed
6
`autopkgtest` test suites from source packages in the Debian archive.
7

8
## Documentation for package maintainers
9

10
The {file:docs/MAINTAINERS.md FAQ for package maintainers} contains useful
11 12
information on how to declare the test suite, how the test is executed,
how to reproduce the test runs locally, etc.
13

14 15 16 17 18
Additionally, we have these extra tutorial-style documentation:

* {file:docs/TUTORIAL.md Functional testing of Debian packages}, a tutorial
  transcribed from a DebConf15 talk on autopkgtest and debci is available that
  covers declaring test suites, issues to consider, and tips and tricks.
19
* [Patterns for Writing As-Installed Tests for Debian Packages](https://deb.li/pattestdeb)
20 21
  is a paper describing patterns (as in "design patterns") for writing tests
  for Debian packages.
22

23
## Deployment
Antonio Terceiro's avatar
Antonio Terceiro committed
24

25 26
See the {file:docs/INSTALL.md installation guide} for instructions on how to
deploy debci to your own infrastructure.
27

28
## Reporting Bugs
29

Antonio Terceiro's avatar
Antonio Terceiro committed
30
Please report bugs against the [debci package](https://bugs.debian.org/debci)
31
in the [Debian BTS](https://bugs.debian.org/).
32

33
## Developer information
34

35 36
* Get source: `git clone https://salsa.debian.org/ci-team/debci.git`
* [Browse source](https://salsa.debian.org/ci-team/debci)
37 38
* {file:docs/HACKING.md How to setup a development environment}
* {file:docs/RUBYAPI.md The Ruby API to the debci data store}
39

40
## Contact
41

42 43
For maintainer queries, general discussion, and also about the development of
debci itself, get in touch:
Antonio Terceiro's avatar
Antonio Terceiro committed
44

45
* mailing list: [debian-ci](https://lists.debian.org/debian-ci)
Antonio Terceiro's avatar
Antonio Terceiro committed
46
* IRC: `#debci` on OFTC
Antonio Terceiro's avatar
Antonio Terceiro committed
47

48
## Copyright and Licensing information
Antonio Terceiro's avatar
Antonio Terceiro committed
49

50
Copyright © the debci development team.
Antonio Terceiro's avatar
Antonio Terceiro committed
51 52 53

debci is free software licensed under the GNU General Public License version 3
or later.