From patchwork Mon Jul 23 07:04:26 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Donnellan X-Patchwork-Id: 947619 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 41Ystx5Ccwz9s3Z for ; Mon, 23 Jul 2018 17:04:57 +1000 (AEST) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 41Ystx1HVtzDr11 for ; Mon, 23 Jul 2018 17:04:57 +1000 (AEST) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com X-Original-To: snowpatch@lists.ozlabs.org Delivered-To: snowpatch@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=au1.ibm.com (client-ip=148.163.158.5; helo=mx0a-001b2d01.pphosted.com; envelope-from=andrew.donnellan@au1.ibm.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from mx0a-001b2d01.pphosted.com (mx0b-001b2d01.pphosted.com [148.163.158.5]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 41Ystn19nNzDqnK for ; Mon, 23 Jul 2018 17:04:48 +1000 (AEST) Received: from pps.filterd (m0098419.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w6N7451G146708 for ; Mon, 23 Jul 2018 03:04:46 -0400 Received: from e06smtp04.uk.ibm.com (e06smtp04.uk.ibm.com [195.75.94.100]) by mx0b-001b2d01.pphosted.com with ESMTP id 2kd8d3c5ee-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Mon, 23 Jul 2018 03:04:45 -0400 Received: from localhost by e06smtp04.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Mon, 23 Jul 2018 08:04:43 +0100 Received: from b06cxnps4076.portsmouth.uk.ibm.com (9.149.109.198) by e06smtp04.uk.ibm.com (192.168.101.134) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Mon, 23 Jul 2018 08:04:42 +0100 Received: from d06av26.portsmouth.uk.ibm.com (d06av26.portsmouth.uk.ibm.com [9.149.105.62]) by b06cxnps4076.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w6N74fPI27852938 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Mon, 23 Jul 2018 07:04:41 GMT Received: from d06av26.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id C2B88AE051; Mon, 23 Jul 2018 10:04:51 +0100 (BST) Received: from d06av26.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 7A33BAE057; Mon, 23 Jul 2018 10:04:51 +0100 (BST) Received: from ozlabs.au.ibm.com (unknown [9.192.253.14]) by d06av26.portsmouth.uk.ibm.com (Postfix) with ESMTP; Mon, 23 Jul 2018 10:04:51 +0100 (BST) Received: from intelligence.ozlabs.ibm.com (haven.au.ibm.com [9.192.254.114]) (using TLSv1.2 with cipher DHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ozlabs.au.ibm.com (Postfix) with ESMTPSA id B8BCCA0129; Mon, 23 Jul 2018 17:04:39 +1000 (AEST) From: Andrew Donnellan To: snowpatch@lists.ozlabs.org, ruscur@russell.cc Date: Mon, 23 Jul 2018 17:04:26 +1000 X-Mailer: git-send-email 2.11.0 X-TM-AS-GCONF: 00 x-cbid: 18072307-0016-0000-0000-000001EA106A X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18072307-0017-0000-0000-0000323EE318 Message-Id: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> MIME-Version: 1.0 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2018-07-22_09:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1806210000 definitions=main-1807230084 Subject: [snowpatch] [PATCH v2 1/6] CONTRIBUTING.md: Update references, add rustfmt information X-BeenThere: snowpatch@lists.ozlabs.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: Continuous Integration for patch-based workflows List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: snowpatch-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "snowpatch" The Rust Guidelines have disappeared, so replace that with a link to the current Rust Style Guide. Document the new rustfmt git pre-commit hook. Update the link to clippy and get rid of outdated installation information that's better documented in the clippy repo anyway. Signed-off-by: Andrew Donnellan --- CONTRIBUTING.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8d040725f3ca..a6daa1feff25 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,14 +24,15 @@ relevant. Specifically, pay attention to: * Separating logical changes into separate patches * Plain-text patches, as generated by `git send-email` -We like to follow the [Rust Guidelines](https://aturon.github.io/) -where possible - patches to fix existing non-compliant code are -welcome! - -If you're using a nightly Rust toolchain, you can use the -[clippy](https://github.com/Manishearth/rust-clippy) linter: `cargo -+nightly install clippy` to install, and `cargo +nightly clippy` to -run. +We like to follow the [Rust Style +Guide](https://github.com/rust-lang-nursery/fmt-rfcs/blob/master/guide/guide.md) +wherever possible - patches to fix any non-compliant code are welcome! +The `setup_rustfmt_hook.sh` script in the root of the repository will +set up a local pre-commit hook that runs `rustfmt` over your changes - +we strongly recommend using this. + +We also recommend using the +[clippy](https://github.com/rust-lang-nursery/rust-clippy) linter. When your patch involves creating a new file, where possible please use a header along the lines of: From patchwork Mon Jul 23 07:04:27 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Andrew Donnellan X-Patchwork-Id: 947621 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 41Ysv15fhlz9s3Z for ; Mon, 23 Jul 2018 17:05:01 +1000 (AEST) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 41Ysv14RrJzDqnM for ; Mon, 23 Jul 2018 17:05:01 +1000 (AEST) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com X-Original-To: snowpatch@lists.ozlabs.org Delivered-To: snowpatch@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=au1.ibm.com (client-ip=148.163.156.1; helo=mx0a-001b2d01.pphosted.com; envelope-from=andrew.donnellan@au1.ibm.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from mx0a-001b2d01.pphosted.com (mx0a-001b2d01.pphosted.com [148.163.156.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 41Ystp35HYzDqnK for ; Mon, 23 Jul 2018 17:04:50 +1000 (AEST) Received: from pps.filterd (m0098409.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w6N745Ci111470 for ; Mon, 23 Jul 2018 03:04:47 -0400 Received: from e06smtp07.uk.ibm.com (e06smtp07.uk.ibm.com [195.75.94.103]) by mx0a-001b2d01.pphosted.com with ESMTP id 2kd4uubg4r-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Mon, 23 Jul 2018 03:04:45 -0400 Received: from localhost by e06smtp07.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Mon, 23 Jul 2018 08:04:43 +0100 Received: from b06cxnps4074.portsmouth.uk.ibm.com (9.149.109.196) by e06smtp07.uk.ibm.com (192.168.101.137) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Mon, 23 Jul 2018 08:04:42 +0100 Received: from d06av21.portsmouth.uk.ibm.com (d06av21.portsmouth.uk.ibm.com [9.149.105.232]) by b06cxnps4074.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w6N74fWE19922996 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Mon, 23 Jul 2018 07:04:41 GMT Received: from d06av21.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id AA17C52050; Mon, 23 Jul 2018 10:04:56 +0100 (BST) Received: from ozlabs.au.ibm.com (unknown [9.192.253.14]) by d06av21.portsmouth.uk.ibm.com (Postfix) with ESMTP id 583AF52059; Mon, 23 Jul 2018 10:04:56 +0100 (BST) Received: from intelligence.ozlabs.ibm.com (haven.au.ibm.com [9.192.254.114]) (using TLSv1.2 with cipher DHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ozlabs.au.ibm.com (Postfix) with ESMTPSA id BB04AA0241; Mon, 23 Jul 2018 17:04:39 +1000 (AEST) From: Andrew Donnellan To: snowpatch@lists.ozlabs.org, ruscur@russell.cc Date: Mon, 23 Jul 2018 17:04:27 +1000 X-Mailer: git-send-email 2.11.0 In-Reply-To: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> References: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> X-TM-AS-GCONF: 00 x-cbid: 18072307-0028-0000-0000-000002DEDB2E X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18072307-0029-0000-0000-00002396B999 Message-Id: <20180723070431.565-2-andrew.donnellan@au1.ibm.com> MIME-Version: 1.0 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2018-07-22_09:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=547 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1806210000 definitions=main-1807230084 Subject: [snowpatch] [PATCH v2 2/6] README.md: Update copyright date X-BeenThere: snowpatch@lists.ozlabs.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: Continuous Integration for patch-based workflows List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: snowpatch-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "snowpatch" Oh, and use proper en_AU as well. Signed-off-by: Andrew Donnellan --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6096bdc41c36..dff8dd64c8b9 100644 --- a/README.md +++ b/README.md @@ -69,9 +69,9 @@ snowpatch is maintained by [Andrew Donnellan](mailto:andrew.donnellan@au1.ibm.com). -License +Licence ------- -Copyright © 2016 IBM Corporation. +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 From patchwork Mon Jul 23 07:04:28 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Donnellan X-Patchwork-Id: 947618 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 41Ystt6xC0z9s3Z for ; Mon, 23 Jul 2018 17:04:54 +1000 (AEST) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 41Ystt5RHlzDqrX for ; Mon, 23 Jul 2018 17:04:54 +1000 (AEST) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com X-Original-To: snowpatch@lists.ozlabs.org Delivered-To: snowpatch@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=au1.ibm.com (client-ip=148.163.158.5; helo=mx0a-001b2d01.pphosted.com; envelope-from=andrew.donnellan@au1.ibm.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from mx0a-001b2d01.pphosted.com (mx0b-001b2d01.pphosted.com [148.163.158.5]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 41Ystn0480zDqRM for ; Mon, 23 Jul 2018 17:04:48 +1000 (AEST) Received: from pps.filterd (m0098419.ppops.net [127.0.0.1]) by mx0b-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w6N745Ch146762 for ; Mon, 23 Jul 2018 03:04:47 -0400 Received: from e06smtp02.uk.ibm.com (e06smtp02.uk.ibm.com [195.75.94.98]) by mx0b-001b2d01.pphosted.com with ESMTP id 2kd8d3c5fg-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Mon, 23 Jul 2018 03:04:46 -0400 Received: from localhost by e06smtp02.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Mon, 23 Jul 2018 08:04:45 +0100 Received: from b06cxnps4076.portsmouth.uk.ibm.com (9.149.109.198) by e06smtp02.uk.ibm.com (192.168.101.132) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Mon, 23 Jul 2018 08:04:42 +0100 Received: from d06av23.portsmouth.uk.ibm.com (d06av23.portsmouth.uk.ibm.com [9.149.105.59]) by b06cxnps4076.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w6N74fNc37159012 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Mon, 23 Jul 2018 07:04:41 GMT Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id AF618A404D; Mon, 23 Jul 2018 10:04:56 +0100 (BST) Received: from d06av23.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 5C986A4057; Mon, 23 Jul 2018 10:04:56 +0100 (BST) Received: from ozlabs.au.ibm.com (unknown [9.192.253.14]) by d06av23.portsmouth.uk.ibm.com (Postfix) with ESMTP; Mon, 23 Jul 2018 10:04:56 +0100 (BST) Received: from intelligence.ozlabs.ibm.com (haven.au.ibm.com [9.192.254.114]) (using TLSv1.2 with cipher DHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ozlabs.au.ibm.com (Postfix) with ESMTPSA id BCFCAA0264; Mon, 23 Jul 2018 17:04:39 +1000 (AEST) From: Andrew Donnellan To: snowpatch@lists.ozlabs.org, ruscur@russell.cc Date: Mon, 23 Jul 2018 17:04:28 +1000 X-Mailer: git-send-email 2.11.0 In-Reply-To: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> References: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> X-TM-AS-GCONF: 00 x-cbid: 18072307-0008-0000-0000-0000025659DE X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18072307-0009-0000-0000-000021BCC5B8 Message-Id: <20180723070431.565-3-andrew.donnellan@au1.ibm.com> MIME-Version: 1.0 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2018-07-22_09:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=8 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1806210000 definitions=main-1807230084 Subject: [snowpatch] [PATCH v2 3/6] README.md: Overview of snowpatch philosophy X-BeenThere: snowpatch@lists.ozlabs.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: Continuous Integration for patch-based workflows List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: snowpatch-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "snowpatch" snowpatch is not unique when it comes to patches + CI. Add some explanations of the overall design philosophy of snowpatch and why it's better than alternatives for some projects. Closes: #4 ("Document alternatives to snowpatch") Signed-off-by: Andrew Donnellan --- v1->v2: - Add note about Patchew (thanks Russell) --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index dff8dd64c8b9..52e3f833f181 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,26 @@ At present, snowpatch supports [Patchwork](http://jk.ozlabs.org/projects/patchwork/) and [Jenkins](http://jenkins-ci.org). +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](https://zuul-ci.org) 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](https://github.com/patchew-project/patchew), may also be appropriate +for projects with suitable workflows. + snowpatch is named in honour of [skiboot](https://github.com/open-power/skiboot), the project which inspired the creation of snowpatch. From patchwork Mon Jul 23 07:04:29 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Donnellan X-Patchwork-Id: 947623 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 41Ysv62QSwz9s3Z for ; Mon, 23 Jul 2018 17:05:06 +1000 (AEST) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 41Ysv60NmNzDqrX for ; Mon, 23 Jul 2018 17:05:06 +1000 (AEST) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com X-Original-To: snowpatch@lists.ozlabs.org Delivered-To: snowpatch@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=au1.ibm.com (client-ip=148.163.156.1; helo=mx0a-001b2d01.pphosted.com; envelope-from=andrew.donnellan@au1.ibm.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from mx0a-001b2d01.pphosted.com (mx0a-001b2d01.pphosted.com [148.163.156.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 41Ysv06nXVzDr0q for ; Mon, 23 Jul 2018 17:05:00 +1000 (AEST) Received: from pps.filterd (m0098394.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w6N73xBG043416 for ; Mon, 23 Jul 2018 03:04:59 -0400 Received: from e06smtp02.uk.ibm.com (e06smtp02.uk.ibm.com [195.75.94.98]) by mx0a-001b2d01.pphosted.com with ESMTP id 2kd8xk2ydx-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Mon, 23 Jul 2018 03:04:58 -0400 Received: from localhost by e06smtp02.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Mon, 23 Jul 2018 08:04:44 +0100 Received: from b06cxnps3075.portsmouth.uk.ibm.com (9.149.109.195) by e06smtp02.uk.ibm.com (192.168.101.132) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Mon, 23 Jul 2018 08:04:42 +0100 Received: from d06av24.portsmouth.uk.ibm.com (d06av24.portsmouth.uk.ibm.com [9.149.105.60]) by b06cxnps3075.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w6N74fg933095724 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Mon, 23 Jul 2018 07:04:41 GMT Received: from d06av24.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 615E142056; Mon, 23 Jul 2018 10:04:57 +0100 (BST) Received: from d06av24.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 1863242049; Mon, 23 Jul 2018 10:04:57 +0100 (BST) Received: from ozlabs.au.ibm.com (unknown [9.192.253.14]) by d06av24.portsmouth.uk.ibm.com (Postfix) with ESMTP; Mon, 23 Jul 2018 10:04:57 +0100 (BST) Received: from intelligence.ozlabs.ibm.com (haven.au.ibm.com [9.192.254.114]) (using TLSv1.2 with cipher DHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ozlabs.au.ibm.com (Postfix) with ESMTPSA id BEF47A0270; Mon, 23 Jul 2018 17:04:39 +1000 (AEST) From: Andrew Donnellan To: snowpatch@lists.ozlabs.org, ruscur@russell.cc Date: Mon, 23 Jul 2018 17:04:29 +1000 X-Mailer: git-send-email 2.11.0 In-Reply-To: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> References: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> X-TM-AS-GCONF: 00 x-cbid: 18072307-0008-0000-0000-0000025659E0 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18072307-0009-0000-0000-000021BCC5B7 Message-Id: <20180723070431.565-4-andrew.donnellan@au1.ibm.com> MIME-Version: 1.0 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2018-07-22_09:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1806210000 definitions=main-1807230084 Subject: [snowpatch] [PATCH v2 4/6] README.md: Update installation instructions X-BeenThere: snowpatch@lists.ozlabs.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: Continuous Integration for patch-based workflows List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: snowpatch-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "snowpatch" Update the installation instructions in preparation for pushing a release to crates.io, which I intend to do very soon. Also clarify that snowpatch will only run on platforms that support both Rust and Git, because I'm not sure snowpatch will run bare-metal on a microcontroller. Signed-off-by: Andrew Donnellan --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 52e3f833f181..f69402635d4d 100644 --- a/README.md +++ b/README.md @@ -45,9 +45,9 @@ creation of snowpatch. Installing ---------- -snowpatch is a [Rust](https://www.rust-lang.org) program. In order to compile -it, you will need Rust and its package manager, Cargo. snowpatch should run -on any target that Rust compiles on, however it has only been tested on Linux. +snowpatch is a [Rust](https://www.rust-lang.org) 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 @@ -59,11 +59,17 @@ We do not provide pre-built binaries at this stage. * [OpenSSL](https://www.openssl.org) headers * [OpenSSH](https://www.openssh.com) headers -### Building +### Installing with cargo -snowpatch can be compiled with `cargo build --release`, which will -download and build the Rust packages we depend on. The executable can -be found in `target/release/snowpatch`. +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`. Contributing From patchwork Mon Jul 23 07:04:30 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Donnellan X-Patchwork-Id: 947620 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [203.11.71.2]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 41Ystz13pXz9s3Z for ; Mon, 23 Jul 2018 17:04:59 +1000 (AEST) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 41Ysty6lyFzDqv6 for ; Mon, 23 Jul 2018 17:04:58 +1000 (AEST) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com X-Original-To: snowpatch@lists.ozlabs.org Delivered-To: snowpatch@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=au1.ibm.com (client-ip=148.163.158.5; helo=mx0a-001b2d01.pphosted.com; envelope-from=andrew.donnellan@au1.ibm.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from mx0a-001b2d01.pphosted.com (mx0b-001b2d01.pphosted.com [148.163.158.5]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 41Ystp0YpXzDqRM for ; Mon, 23 Jul 2018 17:04:49 +1000 (AEST) Received: from pps.filterd (m0098421.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w6N73xnD007447 for ; Mon, 23 Jul 2018 03:04:47 -0400 Received: from e06smtp01.uk.ibm.com (e06smtp01.uk.ibm.com [195.75.94.97]) by mx0a-001b2d01.pphosted.com with ESMTP id 2kd7venbec-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Mon, 23 Jul 2018 03:04:46 -0400 Received: from localhost by e06smtp01.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Mon, 23 Jul 2018 08:04:45 +0100 Received: from b06cxnps4074.portsmouth.uk.ibm.com (9.149.109.196) by e06smtp01.uk.ibm.com (192.168.101.131) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Mon, 23 Jul 2018 08:04:42 +0100 Received: from d06av25.portsmouth.uk.ibm.com (d06av25.portsmouth.uk.ibm.com [9.149.105.61]) by b06cxnps4074.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w6N74f1A6094896 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Mon, 23 Jul 2018 07:04:41 GMT Received: from d06av25.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id A06F811C052; Mon, 23 Jul 2018 10:04:56 +0100 (BST) Received: from d06av25.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 4D9C111C050; Mon, 23 Jul 2018 10:04:56 +0100 (BST) Received: from ozlabs.au.ibm.com (unknown [9.192.253.14]) by d06av25.portsmouth.uk.ibm.com (Postfix) with ESMTP; Mon, 23 Jul 2018 10:04:56 +0100 (BST) Received: from intelligence.ozlabs.ibm.com (haven.au.ibm.com [9.192.254.114]) (using TLSv1.2 with cipher DHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ozlabs.au.ibm.com (Postfix) with ESMTPSA id C1005A0273; Mon, 23 Jul 2018 17:04:39 +1000 (AEST) From: Andrew Donnellan To: snowpatch@lists.ozlabs.org, ruscur@russell.cc Date: Mon, 23 Jul 2018 17:04:30 +1000 X-Mailer: git-send-email 2.11.0 In-Reply-To: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> References: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> X-TM-AS-GCONF: 00 x-cbid: 18072307-4275-0000-0000-0000029C4471 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18072307-4276-0000-0000-000037A474EC Message-Id: <20180723070431.565-5-andrew.donnellan@au1.ibm.com> MIME-Version: 1.0 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2018-07-22_09:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1806210000 definitions=main-1807230084 Subject: [snowpatch] [PATCH v2 5/6] README.md: Add information about project status and documentation X-BeenThere: snowpatch@lists.ozlabs.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: Continuous Integration for patch-based workflows List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: snowpatch-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "snowpatch" Signed-off-by: Andrew Donnellan --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index f69402635d4d..d03be5d56bc8 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,18 @@ snowpatch is named in honour of 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 ---------- @@ -72,6 +84,16 @@ To compile snowpatch manually, clone the git repository and run `cargo build executed using `cargo run`. +Documentation +------------- + +For usage information, run `snowpatch --help`. + +Example configurations can be found in the [`examples`](examples) directory. + +Additional documentation can be found in the [`docs`](docs) directory. + + Contributing ------------ From patchwork Mon Jul 23 07:04:31 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Andrew Donnellan X-Patchwork-Id: 947622 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 41Ysv32ss6z9s3Z for ; Mon, 23 Jul 2018 17:05:03 +1000 (AEST) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from lists.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 41Ysv31VhwzDr2m for ; Mon, 23 Jul 2018 17:05:03 +1000 (AEST) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com X-Original-To: snowpatch@lists.ozlabs.org Delivered-To: snowpatch@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=pass (mailfrom) smtp.mailfrom=au1.ibm.com (client-ip=148.163.156.1; helo=mx0a-001b2d01.pphosted.com; envelope-from=andrew.donnellan@au1.ibm.com; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=au1.ibm.com Received: from mx0a-001b2d01.pphosted.com (mx0a-001b2d01.pphosted.com [148.163.156.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 41Ystr4crfzDqRM for ; Mon, 23 Jul 2018 17:04:52 +1000 (AEST) Received: from pps.filterd (m0098399.ppops.net [127.0.0.1]) by mx0a-001b2d01.pphosted.com (8.16.0.22/8.16.0.22) with SMTP id w6N73wHd134716 for ; Mon, 23 Jul 2018 03:04:50 -0400 Received: from e06smtp02.uk.ibm.com (e06smtp02.uk.ibm.com [195.75.94.98]) by mx0a-001b2d01.pphosted.com with ESMTP id 2kd7r4x1v3-1 (version=TLSv1.2 cipher=AES256-GCM-SHA384 bits=256 verify=NOT) for ; Mon, 23 Jul 2018 03:04:50 -0400 Received: from localhost by e06smtp02.uk.ibm.com with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted for from ; Mon, 23 Jul 2018 08:04:46 +0100 Received: from b06cxnps4074.portsmouth.uk.ibm.com (9.149.109.196) by e06smtp02.uk.ibm.com (192.168.101.132) with IBM ESMTP SMTP Gateway: Authorized Use Only! Violators will be prosecuted; (version=TLSv1/SSLv3 cipher=AES256-GCM-SHA384 bits=256/256) Mon, 23 Jul 2018 08:04:44 +0100 Received: from d06av26.portsmouth.uk.ibm.com (d06av26.portsmouth.uk.ibm.com [9.149.105.62]) by b06cxnps4074.portsmouth.uk.ibm.com (8.14.9/8.14.9/NCO v10.0) with ESMTP id w6N74hhT32505966 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=FAIL); Mon, 23 Jul 2018 07:04:43 GMT Received: from d06av26.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id 9791AAE051; Mon, 23 Jul 2018 10:04:53 +0100 (BST) Received: from d06av26.portsmouth.uk.ibm.com (unknown [127.0.0.1]) by IMSVA (Postfix) with ESMTP id F1A0CAE055; Mon, 23 Jul 2018 10:04:52 +0100 (BST) Received: from ozlabs.au.ibm.com (unknown [9.192.253.14]) by d06av26.portsmouth.uk.ibm.com (Postfix) with ESMTP; Mon, 23 Jul 2018 10:04:52 +0100 (BST) Received: from intelligence.ozlabs.ibm.com (haven.au.ibm.com [9.192.254.114]) (using TLSv1.2 with cipher DHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by ozlabs.au.ibm.com (Postfix) with ESMTPSA id CCC5EA039A; Mon, 23 Jul 2018 17:04:39 +1000 (AEST) From: Andrew Donnellan To: snowpatch@lists.ozlabs.org, ruscur@russell.cc Date: Mon, 23 Jul 2018 17:04:31 +1000 X-Mailer: git-send-email 2.11.0 In-Reply-To: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> References: <20180723070431.565-1-andrew.donnellan@au1.ibm.com> X-TM-AS-GCONF: 00 x-cbid: 18072307-0008-0000-0000-0000025659E1 X-IBM-AV-DETECTION: SAVI=unused REMOTE=unused XFE=unused x-cbparentid: 18072307-0009-0000-0000-000021BCC5BA Message-Id: <20180723070431.565-6-andrew.donnellan@au1.ibm.com> MIME-Version: 1.0 X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2018-07-22_09:, , signatures=0 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 malwarescore=0 suspectscore=0 phishscore=0 bulkscore=0 spamscore=0 clxscore=1015 lowpriorityscore=0 mlxscore=0 impostorscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1806210000 definitions=main-1807230084 Subject: [snowpatch] [PATCH v2 6/6] docs: Add configuration documentation X-BeenThere: snowpatch@lists.ozlabs.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: Continuous Integration for patch-based workflows List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: snowpatch-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "snowpatch" Add some basic configuration documentation that explains the config file format. Closes: #1 ("Documentation for usage and configuration") Signed-off-by: Andrew Donnellan --- docs/configuration.md | 169 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 169 insertions(+) create mode 100644 docs/configuration.md diff --git a/docs/configuration.md b/docs/configuration.md new file mode 100644 index 000000000000..c7b3b8d66a8e --- /dev/null +++ b/docs/configuration.md @@ -0,0 +1,169 @@ +Configuration +============= + +snowpatch configuration files are in [TOML](https://en.wikipedia.org/wiki/TOML) +format. + +Example configuration files can be found in the [examples](../examples) +directory. + +A snowpatch configuration file contains three global configuration sections +(tables, in TOML terms), `git`, `patchwork` and `jenkins`, and a `projects` +section containing per-project configuration. + + +Git Configuration +----------------- + +The `git` section contains settings for the git SSH transport. + +Example: + +``` +[git] +user = "git" +public_key = "/home/ruscur/.ssh/id_rsa.pub" +private_key = "/home/ruscur/.ssh/id_rsa" +``` + +- `user`: git SSH username (Currently, snowpatch only supports a single git + username for all git remotes - this will be addressed in future.) + +- `public_key`: path to SSH public key, usually `~/.ssh/id_rsa.pub` (optional) + +- `private_key`: path to SSH private key, usually `~/.ssh/id_rsa` + +- `passphrase`: passphrase for SSH private key (optional) + +Patchwork Configuration +----------------------- + +The `patchwork` section contains settings for the Patchwork instance being +monitored. + +Example: + +``` +[patchwork] +url = "https://russell.cc/patchwork" +port = 443 # optional +user = "ruscur" +pass = "banana" +polling_interval = 10 # polling interval in minutes +``` + +- `url`: base URL of the Patchwork instance + +- `port`: port number (optional) + +- `user`: Patchwork username (must be used in conjuction with `pass`) + +- `pass`: Patchwork password (must be used in conjuction with `user`) + +- `token`: Patchwork API token (can be used instead of `user`/`pass`) + +- `polling_interval`: Patchwork polling interval, in minutes + + +Jenkins Configuration +--------------------- + +The `jenkins` section contains settings for the Jenkins instance being used for +builds. + +Example: + +``` +[jenkins] +url = "https://jenkins.ozlabs.ibm.com" +port = 443 +username = "patchwork" +token = "33333333333333333333333333333333" +``` + +- `url`: base URL of the Jenkins instance + +- `port`: port number (optional) + +- `username`: Jenkins username (optional, must be used in conjunction with + `token`) + +- `token`: Jenkins API token (optional, must be used in conjunction with + `username`) + + +Project Configuration +--------------------- + +The `projects` section consists of subsections for each project, which must be +named `project.PROJECT_NAME`, where `PROJECT_NAME` corresponds to the short name +("linkname") of the project in Patchwork. + +Within each project subsection, there is an array called `jobs` which consists +of a table for each Jenkins job that should executed. + +Example: + +``` + [projects.linuxppc-dev] + repository = "/home/ruscur/Documents/linux" + branches = ["master", "powerpc-next"] + # test_all_branches defaults to true + remote_name = "github" + remote_uri = "git@github.com:ruscur/linux.git" + push_results = false + + [[projects.linuxppc-dev.jobs]] + job = "linux-build-manual" + remote = "GIT_REPO" + branch = "GIT_REF" + artifact = "snowpatch.txt" + hefty = true + DEFCONFIG_TO_USE = "pseries_le_defconfig" + + [[projects.linuxppc-dev.jobs]] + job = "linux-build-manual" + remote = "GIT_REPO" + branch = "GIT_REF" + artifact = "snowpatch.txt" + hefty = false + DEFCONFIG_TO_USE = "ppc64le_defconfig" +``` + +- `repository`: path to local clone of git repository + +- `branches`: a list of base branches (as defined by the local git repository) + that patches should be tested against + +- `test_all_branches`: if true, each patch will be tested against all base + branches. If false, a patch will only be tested against the first base branch + to which it successfully applies. (Optional, defaults to true) + +- `remote_name`: the name of the remote, as defined in the local git repository, + to which branches should be pushed so that the Jenkins server can pull them + +- `remote_uri`: the URI of the remote + +- `push_results`: whether test results should be pushed to Patchwork for this project + +Individual jobs contain the following: + +- `job`: the name of the Jenkins job to run + +- `title`: title of the test which will appear in Patchwork (Optional, defaults + to job name) + +- `remote`: the name of the Jenkins build parameter in which the URI of the git + remote will be filled + +- `branch`: the name of the Jenkins build parameter in which the name of the git + branch to which the patch has been applied will be filled + +- `hefty`: whether this job is a "hefty" test. Hefty tests will only be run on + the final patch of a series, while non-hefty tests will be run on every patch + in the series. (Optional, defaults to false) + +- `warn_on_fail`: if true, this job will return a warning rather than a failure + if it fails (Optional, defaults to false) + +- Any further parameters will be passed to Jenkins as build parameters \ No newline at end of file