fedora-infra / rpmautospec

Clone

#45 Document how to install rpmautospec
Merged 4 years ago by nphilipp. Opened 4 years ago by pingou.
fedora-infra/ pingou/rpmautospec install_doc  into  master

file modified
+1 
@@ -13,6 +13,7 @@ 
 

     opting-in
 

     autorel
 

     autochangelog
 

+    install

file added
+54 
@@ -0,0 +1,54 @@ 
 

+ Installing rpmautospec
 

+ ======================
 

+ 

+ rpmautospec is composed of a few elements:
 

+ - a python library (which includes a small CLI tool)
 

+ - a koji-hub plugin
 

+ - a koji-builders plugin
 

+ 

+ Each needs to be correctly installed and configured for rpmautospec to work
 

+ properly.
 

+ 

+ .. Note: This document relies on the premise that koji-hub runs on python2
 

+ while the builders are running in python3.
 

+ 

+ 

+ Installing the python library
 

+ -----------------------------
 

+ 

+ The python library is handled via a traditional ``setup.py`` file. It can
 

+ therefore be installed simply by doing:
 

+ 

+ `` python setup.py install``.
 

+ 

+ .. warning: that the library is python3 only except for a sub-package:
 

+     ``rpmautospec.py2compat``.
 

+ 

+ 

+ Installing the koji-hub plugin
 

+ ------------------------------
 

+ 

+ The koji plugin ``rpmautospec_hub`` is meant to be installed on the koji hub
 

+ in: ``/usr/lib/koji-hub-plugins/``.
 

+ It is python2 compatible and requires the package ``rpmautospec.py2compat``.
 

+ 

+ This plugin also requires a configuration file at:
 

+ ``/etc/koji-hub/plugins/rpmautospec_hub.conf``
 

+ 

+ An example configuration file can be found in the sources at:
 

+ ``koji_plugins/rpmautospec_hub.conf``
 

+ 

+ The plugin can then be enabled by adding: ``rpmautospec_hub`` in the line
 

+ ``Plugins`` in the ``/etc/koji-hub/hub.conf`` configuration file for koji hub.
 

+ 

+ 

+ Installing the koji-builders plugin
 

+ -----------------------------------
 

+ 

+ The koji plugin ``rpmautospec_builder`` is meant to be installed on all the
 

+ koji builders running the ``buildSRPMFromSCM`` task in:
 

+ ``/usr/lib/koji-builder-plugins/``.
 

+ 

+ The plugin then can be enabled by adding: ``rpmautospec_builder`` in the line
 

+ ``plugins`` in the ``/etc/kojid/kojid.conf`` configuration file for the koji
 

+ builders.

file modified
+1 -1 
@@ -16,7 +16,7 @@ 
 

  def autotag_cb(cb_type, **kwargs):
 

      global CONFIG
 

  

-     log = logging.getLogger("koji.plugin.tag_in_pagure")
 

+     log = logging.getLogger("koji.plugin.rpmautospec_hub")
 

  

      if not CONFIG:
 

          try:

no initial comment

rebased onto eb709be39cb83b2e4e86c7a9194ecdd5bc55115d
4 years ago

rebased onto 2470e31b44c4eb99ac231df420480e8545b738b8
4 years ago

Build failed.

Do mention the CLI as well?

at koji_plugins/rpmautospec_hub.conf.

Adjusted the first line to be: - a python library (which includes a small CLI tool)

Adjusted to:

An example configuration file can be found in the sources at:
``koji_plugins/rpmautospec_hub.conf``

rebased onto e6b8ff102e135f49c8d950c14f429805557d6aa3
4 years ago

Build succeeded.

It's a "sub-package".

Metadata Update from @nphilipp:
- Request assigned
4 years ago

"...the package..."

"The the plugin can be..." or "The plugin can then be..."

"on the koji hub" -> "on all koji builders"

I assume it has to be on all builders, or at least all builders that can run buildSRPMFromSCM tasks.

"rpmautospec_builder"

Don't we speak about modules in the python ecosystem?

To me package sounds more like RPM package

I went for the later :)

Fixed and I'll add the precision about buildSRPMFromSCM

:blush:

rebased onto 8fcc085
4 years ago

LGTM, thanks!

Build succeeded.

Pull-Request has been merged by nphilipp
4 years ago
Changes Summary 3
+1 -0
file changed
doc/index.rst
+54
file added
doc/install.rst
+1 -1
file changed
koji_plugins/rpmautospec_hub.py
Powered by Pagure 5.13.3
Documentation • File an Issue • About • SSH Hostkey/Fingerprint
© Red Hat, Inc. and others.