Scroll to navigation

MINI-BUILDD-API(1) User Commands MINI-BUILDD-API(1)

NAME

mini-buildd-api - Run API calls against a mini-buildd instance

DESCRIPTION

usage: mini-buildd-api [-h] [--version] [-l LOG_LEVEL] [-J] [--auto-confirm]

[--auto-save-passwords] [--script-mode]
<call> [options] ...

Run API calls against a mini-buildd instance

options:

show this help message and exit
show program's version number and exit
set log level (if none given, ['WARNING', 'mini_buildd.INFO'] is applied by default). May also be given as ``<logger>.<level>`` to effect individual loggers only, and multiple times (check existing logs for actual logger names). (default: None)
use parsable json output (default: False)
force-bypass extra confirmation (for confirmable calls) (default: False)
don't ask before saving passwords (via python3-keyring) (default: False)
force not to be interactive (default: False)

API calls (run 'mini-buildd-api <call> --help' for full single call help):

<call> [options]
Get status of this instance
JSON result description:
{
"version": mini-buildd's version "identity": Instance identity "url": Instance URL (HTTP) "incoming_url": Incoming URL (currently FTP) "load": Instance's (0 =< load <= 1). If negative, the instance is stopped "chroots": List of active chroots "remotes": Active or auto-reactivatable remotes ["repositories": Simplified structural representation of all repositories]
}
.
Get public key
Get ASCII-armored GnuPG public key of this instance.
Used to sign the apt repositories (apt key) and for authorization across instances.
.
Get recommended dput config snippet
Usually, this is for integration in your personal ``~/.dput.cf``.
.
Get sources.list (apt lines)
Usually, this output is put to a file like ``/etc/apt/sources.list.d/mini-buildd-xyz.list``.
.
List source package in repository
.
Show source package in repository
.
Compare two internal source packages
.
Migrate source package
run for a rollback distribution, this will perform a rollback restore.
.
Remove source package
Removes a source package along with all its binary packages.
.
Port internal source package
rebuild of the given locally-installed package.
When ``from_distribution`` equals ``to_distribution``, a rebuild will be done.
.
Port external source package
rebuild of any given source package.
.
Retry a previously failed source package
JSON result description:
Changes file name that has been re-uploaded
.
Cancel an ongoing package build
.
Set a user's GnuPG public key
.
Subscribe to (email) notifications
.
Unsubscribe from (email) notifications
.
Remake chroots
Run actions 'remove', 'prepare', 'check' and 'activate'.
Note that Daemon will be stopped before running, cancelling ongoing events (``BUILDING``, ``PACKAGING``).
.
Start Daemon (accept incoming)
Does nothing if already started; will fail if Daemon instance is not activated.
.
Stop Daemon (stop accepting incoming)
Does nothing if already stopped. Any possibly running builds will be cancelled.
This state is *not persisted*. Please *deactivate* the Daemon instance via :mbdpage:`setup` to persist over *mini-buildd service* restarts.
.
Wake a remote instance
.
Check if signed message matches a remote, reply our signed message on success
This is for internal use only.
.
Run a cron job now (out of schedule)
.
Get upload permissions for repositories
.
Get list of repository snapshots for a distribution
.
Create a repository snapshot
.
Delete a repository snapshot
.
Make local partial repository mirror via :debpkg:`debmirror`
only ``stable``, omit rollbacks) variant of your repo somewhere remote.
.
Build keyring packages
.
Build test packages
.
Create, update or inspect your setup
Note that Daemon will be stopped before running, cancelling ongoing events (``BUILDING``, ``PACKAGING``).
.

Note: Uses ``python3-keyring`` to persist passwords (see ``man 1 keyring``)

December 2024 mini-buildd-api 2.2.5~bpo12+1