Go to file
Valentin Deniaud a0de07b676
gitea/eobuilder/pipeline/head This commit looks good Details
misc: update git-blame-ignore-revs to ignore quote changes (#79788)
2023-08-16 11:52:32 +02:00
debian debian: use debhelper compat level 12 2021-12-12 11:40:34 +01:00
eobuilder misc: apply double-quote-string-fixer (#79788) 2023-08-16 11:52:32 +02:00
.git-blame-ignore-revs misc: update git-blame-ignore-revs to ignore quote changes (#79788) 2023-08-16 11:52:32 +02:00
.gitignore add support for a local_settings.py file 2015-08-19 12:29:23 +02:00
.pre-commit-config.yaml misc: add pre commit hook to force single quotes (#79788) 2023-08-16 11:52:32 +02:00
Jenkinsfile ci: build deb package for bookworm (#78968) 2023-06-23 17:29:58 +02:00
MANIFEST.in include dput.cf to source package (#36756) 2019-12-10 17:04:34 +01:00
Makefile misc: remove i386 references (#78330) 2023-06-12 12:34:08 +02:00
README.rst misc: add black files/notes 2021-01-11 19:08:28 +01:00
dput.cf add bookworm support (and remove buster) (#78329) 2023-06-12 09:33:39 +02:00
entrouvert.gpg Makefile: install entrouvert keyring in pbuilder chroots 2016-02-24 16:25:36 +01:00
eobuildall misc: defaults to bullseye (#72729) 2022-12-22 17:16:17 +01:00
eobuilder-ctl misc: apply double-quote-string-fixer (#79788) 2023-08-16 11:52:32 +02:00
eobuilder.cron eobuilder-ctl: debug smart cleanning 2014-02-26 22:01:47 +01:00
eobuilder.sh change launcher script to get configuration from /etc/ (#74863) 2023-03-02 10:08:20 +01:00
gitconfig Initial import from admin sys repository 2013-08-08 18:24:29 +02:00
pbuilderrc add bookworm support (and remove buster) (#78329) 2023-06-12 09:33:39 +02:00
setup.py misc: apply double-quote-string-fixer (#79788) 2023-08-16 11:52:32 +02:00
tox.ini add tox.ini 2016-02-23 00:20:34 +01:00

README.rst

=======
README
=======

Requirements
------------

You must use a Debian OS. You need to install make.

Installation
------------

Install eobuilder::

    sudo make install

Install chroots (if you want i386 - amd64 wheezy and squeeze)::

    sudo make chroots

Configuration
-------------

Generate a ssh key for eobuilder user or use an existing one.
Configure your Debian repository to allow this key.

You need to add this line into your sudoers::

    eobuilder       ALL=  SETENV:NOPASSWD:/usr/sbin/cowbuilder

Quick start
------------

Example with python-entrouvert::

    su eobuilder -p -c "eobuilder -a amd64 -d squeeze,wheezy wcs"
    su eobuilder -p -c "eobuilder -a amd64 -d wheezy auquotidien"
    su eobuilder -p -c "eobuilder -a i386,amd64 -d squeeze lasso"
    su eobuilder -p -c "eobuilder -c deb"

Note that the SSH host key verification will fail unless the proper
known_hosts file has been installed, or created by manually connecting
to the git server.

Code Style
----------

black is used to format the code, using thoses parameters:

    black --target-version py37 --skip-string-normalization --line-length 110

There is .pre-commit-config.yaml to use pre-commit to automatically run black
before commits. (execute `pre-commit install` to install the git hook.)

Packaging
---------

To make your git repository compatible with eobuilder you need to add a Debian branch
with a debian folder.
You can also use debian-DIST branches.

EO Builder supports 3 types of sources at the moment :

Python
    You need at least a setup.py which supports options :
    --name, --version, --fullname, sdist --formats=bztar and clean --all
    Example: http://repos.entrouvert.org/portail-citoyen-announces.git

Autotools
    You need at least an autogen.sh and a configure.ac files. You also need a script to generate
    version numbers like : http://repos.entrouvert.org/lasso.git/tree/tools/git-version-gen
    Example: http://repos.entrouvert.org/lasso.git

Makefile
    You need to have a Makefile file with at least the following targets :
    version, name, fullname and dist-bzip2 targets


Exit Codes
----------

- 0: success
- 1: unspecified error
- 2: unsupported project type