Enabling continuous integration for patch-based development workflows.
Branch: master
Clone or download
ajdlinux README: Add IRC channel
Signed-off-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com>
Latest commit b192ebd Feb 5, 2019

README.md

snowpatch - CI for patches

Build Status Crates.io

Overview

snowpatch is a continuous integration tool for projects using a patch-based, mailing-list-centric git workflow. This workflow is used by a number of well-known open source projects such as the Linux kernel.

snowpatch serves as a bridge between a patch tracking system and a continuous integration automation server. snowpatch monitors the patch queue for incoming patches, applies patches on top of an existing tree, triggers appropriate builds and test suites, and reports the results.

At present, snowpatch supports Patchwork and Jenkins.

snowpatch is designed in line with Patchwork's philosophy of supplementing, rather than replacing, existing workflows. For projects which already use Patchwork as their core patch management tool, snowpatch does not impose any additional changes to the development workflow.

snowpatch requires nothing more than a Patchwork account and Jenkins account with appropriate permissions and an API key. Many projects using patch-based workflows are highly decentralised, using Patchwork instances they do not administer, and build machines hidden behind corporate firewalls. As such, snowpatch is designed not to require administrator access or additional plugins for either Patchwork or Jenkins.

snowpatch is deliberately minimalistic, which distinguishes it from tools like Zuul which are more sophisticated and may be more appropriate for projects with a better ability to adapt their workflow around a comprehensive CI system. Other patch tracking systems that provide integrated support for CI systems, such as Patchew, may also be appropriate for projects with suitable workflows.

snowpatch is named in honour of skiboot, the project which inspired the creation of snowpatch.

Project Status

snowpatch is currently under heavy development. It implements enough core functionality to be useful for basic CI requirements, and is currently deployed in production for a small number of projects. There are many core features that are still yet to be implemented, and documentation is still incomplete.

At this stage, there are no stability guarantees, and behaviour is liable to change significantly in new versions without notice.

Installing

snowpatch is a Rust program. In order to compile it, you will need Rust and its package manager, Cargo. snowpatch should run on any target that supports Rust and Git, however it has only been tested on Linux. We do not provide pre-built binaries at this stage.

Non-Rust dependencies

  • git: we try to use the git2-rs library where possible, but we still need the binary for a few operations.
  • CMake
  • OpenSSL headers
  • OpenSSH headers

Installing with cargo

To install the latest tagged release of snowpatch using cargo, run cargo install snowpatch, which will download and compile snowpatch and all its Rust dependencies. The snowpatch binary will be installed as snowpatch.

Building manually

To compile snowpatch manually, clone the git repository and run cargo build --release. The executable can be found in target/release/snowpatch or executed using cargo run.

Documentation

For usage information, run snowpatch --help.

Example configurations can be found in the examples directory.

Additional documentation can be found in the docs directory.

Contributing

Please read our contribution guidelines for more information about contributing.

Contact

snowpatch development is done on our mailing list, snowpatch@lists.ozlabs.org. To subscribe, go to the listinfo page.

Patches are tracked on patchwork.ozlabs.org.

Our IRC channel is #snowpatch on Freenode.

snowpatch is maintained by Russell Currey and Andrew Donnellan.

Licence

Copyright © 2016-2018 IBM Corporation.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.