fedora-infra / review_stats

Created 7 months ago
Maintained by cverna
A tool to generate cached HTML pages with statistics about Fedora review tickets
Members 3
Mattia Verga committed 2 months ago

review_stats

A tool to generate cached HTML pages with statistics about Fedora review tickets.

Description

This tool is used by fedora-infrastructure to generate some HTML pages with useful statistics about new package review tickets opened in Red Hat Bugzilla. It's also responsible for managing stale review tickets, asking for submitter or reviewer updates and closing or resetting the ticket state when appropriate.

Usage

review-stats make-pages -d <OUTPUT_HTML_DIR>

review_stats requires a configuration file to be set up before usage. An example review-stats.cfg is provided by the package.

Config file parameters description

url: URL of the xmlrpc Bugzilla server instance. Defaults to Red Hat Bugzilla server.

username / password: for authentication to the Bugzilla server.

bugzilla_api_key: alternative to username/password authentication.

journal_level: store run information to systemd journal with the desired level.

mail_level: send log messages of the desired level to a list of email addresses. Be aware these addresses will receive one email for each log message sent to the queue! Using a level lower than ERROR is discouraged.

mail_server: the SMTP server to use for sending emails with the format server:port.

mail_username / mail_password: for authentication to the SMTP server.

mail_secure: set to true if SSL authentication is needed.

mail_from: sender address.

mail_to: comma separated list of email addresses.

Base command parameters

-c, --config FILENAME: the config file to use. By default the script will automatically search for it in /etc/.

-l, --enable-systemd-log: enable logging to system's journal via systemd.

-v, --verbose: set console output to INFO level.

-D, --debug: set console output to DEBUG level.

make-pages parameters

-t, --templatedir PATH: a path to the directory where HTML templates are stored. By default the script will automatically search for them in the package install dir.

*-s, --staticfilesdir PATH: a path to the directory where static files are stored. By default the script will automatically search for them in the package install dir.

-d, --destination PATH [required]: the path where generated HTML files should be copied.

work-on-bugs parameters

-d, --dry-run: do not really operate on bugs, but only output debug messages.