relvalconsumer 1.3.0

Requirements

Python libraries:

• fedmsg

• fedfind

• wikitcms

• mwclient

Optionally also relval itself, to run image size check tests on the created events.

Installation

Install the required external Python libraries, then use setuptools to install, e.g.:

python setup.py install

Test and production modes

Two consumers are provided, a ‘test’ and a ‘production’ consumer. For ‘test’:

• The consumer listens for dev (not prod) messages

• The consumer does not validate message signatures

• The consumer creates events on the staging wiki (not production wiki)

• The announcement email is logged rather than being mailed out

In this mode it is fairly safe to play around with the consumer, and you can use a tool like fedmsg-dg-replay to trigger event creation by replaying a relevant fedmsg (which will show up with a dev topic rather than prod).

For ‘production’:

• The consumer listens for prod (not dev) messages

• The consumer validates message signatures

• The consumer creates events on the production wiki

• The consumer sends email notifications to public mailing lists

PLEASE do not enable the production consumer unless you’re absolutely sure it’s your job to create the official events.

The fedmsg config keys for the consumers are relvalconsumer.test.enabled and relvalconsumer.prod.enabled respectively.

License

relvalconsumer is released under the GPL, version 3 or later. See COPYING and the header of relvalconsumer.py itself.

Contributing

Issues and pull requests can be filed in Pagure. Pull requests must be signed off (use the -s git argument). By signing off your pull request you are agreeing to the Developer’s Certificate of Origin:

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.