Repository files navigation

Ruby Post-Publishing Processor - Polish your Ruby projects with ease!

 .77                                                                 7.  +$                                                                 =~+?ZZZII                                                           .Z$$$$$$$~~:,.$Z                                                           $~~:,.7 ?~:,, .......................................redmine...............=~:,,.  ~::,..rails.......................................................~~:,.  ~~:,, .........rack................json...........................=~:,,  =~::,.....................sass............activerecord..............~::,.   ~~:,.=....eruby...................................................~~:,.~   +~:,,.................haml......................eventmachine.......?~::,.    ~::,. ........................rspec................................~~:,.:    =~:,,:.........................................bundler.............~~:,,     ~I7I..........rvm..................rake...........................,~7?II    $$$$$$$O                                                           $$$$$$$$     .ZO7Z,                                                             .+ZIZ.        7                                                                  7        $I                                                                 ZI

Polisher is a Ruby module and set of utilities aimed to assisting the post-publishingpackaging process for Ruby gems and applications.

Provided are a series of tools geared towards querying rubygems.org and other upstreamruby sources for metadata as well as downstream sources such as the Fedora and Debiandistributions to cross reference various supported stacks vendored by each.

Polisher also includes utilities to integrate and hook into various build and install workflowsused by both upstream and downstream developers to synergize operations and streamlinethe packaging and support process.

Polisher is made available throughrubygems.

Polisher dependends on the 'curb' rubygem which in return depends on the curl-develheaders. The user should install those and the development tools for their platformor install the curb gem packaged by their distribution like so:

# For Fedora 21 and below also enterprise linux replace dnf with yum# install the ruby & curl headers & development tools...dnf install ruby-devel libcurl-develdnf group install "Development Tools"# ... or install the gem manuallydnf install rubygem-curb

Replace the 'yum install' commands with the corresponding ones on alternate platforms.

Various polisher subcomponents depend on various command line utilities, these include:

• /usr/bin/git - to checkout git repos
• /usr/bin/koji - to query and build against koji
• /usr/bin/yum - to query yum
• /usr/bin/md5sum - to generate required metadata
• /usr/bin/fedpkg - to query fedora

Some of these are pre-installed on many platforms and some are available via a quick'dnf install' / 'apt-get' or other. Not all are required for all utilities, see thespecific executables and modules for details.

To install the latest release and all ruby dependencies simply run:

gem install polisher

See the bin/ directory for all executables available, pass '-h' to any tosee specific command line options. To run any command from a local git checkoutof polisher, run the following beforehand:

export RUBYLIB='lib'

Polisher comes with complete documentation and a full test suite.

Documentation relies on the 'yard' gem / documentation system, togenerate run:

rake yard

The test suite is based on rspec, to run:

rake spec

Polisher is Licensed under theMIT License, Copyright (C) 2013-2016 Red Hat, Inc.

See the commit log for authors of the project. All feedback and contributionsare more than welcome.

• Mo Morsi
• Jason Frey
• Joe Rafaniello
• Ken Dreyer
• Achilleas Pipinellis
• Oleg Barenboim
• Dominic Cleal
• Josef Stribny
• Sourav Moitra