FedoraReview

Created 3 years ago
Maintained by leamas
fedora-review tool, development site
Members 6
fedora-review: Tools to help review packages for inclusion in Fedora
---------------------------------------------------------------------

This tool automates much of the dirty work when reviewing a package
for the Fedora Package Collection.

Like:
- Downloading SRPM & SPEC from Bugzilla report
- Build and install package in mock
- Download upstream source
- Check md5sums
- Run rpmlint
- Generate review template with both manual & automated checks serving
  as a starting point for the review work.

Contacts
--------

* IRC: #fedora-review @ freenode
* Mailing list: https://lists.fedoraproject.org/admin/lists/fedorareview.lists.fedorahosted.org/
* Wiki: https://pagure.io/FedoraReview


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

Install the package out of the Fedora repositories:

    $ sudo dnf -y install fedora-review

See man fedora-review for further details about the setup.


Download
--------

Clone the source using:

    $ git clone https://pagure.io/FedoraReview.git

Dependencies
------------

Install dependencies:

    $ sudo dnf -y install mock
    $ sudo dnf -y builddep fedora-review.spec

The mock requirement is not hard, it's possible to use fedora-review
without mock when always using the --prebuilt/-p option. This means
that packages must be built using other tools e. g., koji. Generally,
installing without mock is not recommended.


Running from git
----------------

After downloading (above) use try-fedora-review:

    $ cd FedoraReview
    $ python3 update-version
    $ python3 try-fedora-review --help

To run from any directory, install try-fedora-review according to
instructions in that script. update-version only needs to run once.


Usage
-----

    $ nroff -man fedora-review.1 | more
    $ fedora-review --help


Extending
---------

As of 0.4, fedora-review has two plugin interfaces:

 * The native Python interface used by modules in the src/checks
   directory. This is the most complete, and is required e. g., when
   defining a new group of tests for a new language. This is
   descibed in the project wiki, at
   https://fedorahosted.org/FedoraReview/wiki/NewPlugin

 * The script interface used by scripts in the scripts/ directory.
   This is a small interface designed to make it possible to write
   simple tests in plain bash. This is covered at
   https://pagure.io/FedoraReview/blob/master/f/SCRIPTS_API

The JSON-based interface which existed in earlier versions has been
retired.


Bugs and issues
---------------

Please report bug and issues at https://pagure.io/FedoraReview/new_issue


License
-------

fedora-review is licensed under GPLv2+, for more details check COPYING.