From patchwork Sun Oct 22 13:15:04 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Maxim Cournoyer X-Patchwork-Id: 55115 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 8F0F027BBEA; Sun, 22 Oct 2023 14:17:05 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_ADSP_CUSTOM_MED, DKIM_INVALID,DKIM_SIGNED,FREEMAIL_FROM,MAILING_LIST_MULTI, SPF_HELO_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 86ACD27BBE2 for ; Sun, 22 Oct 2023 14:17:04 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1quYJu-000291-KC; Sun, 22 Oct 2023 09:16:43 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1quYJm-00028q-Qf for guix-patches@gnu.org; Sun, 22 Oct 2023 09:16:34 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1quYJm-00072D-HJ for guix-patches@gnu.org; Sun, 22 Oct 2023 09:16:34 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1quYKE-0005YW-LY for guix-patches@gnu.org; Sun, 22 Oct 2023 09:17:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#66681] [PATCH] doc: Document Cuirass build notifications. Resent-From: Maxim Cournoyer Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 22 Oct 2023 13:17:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 66681 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 66681@debbugs.gnu.org, maxim.cournoyer@gmail.com X-Debbugs-Original-To: guix-patches@gnu.org, maxim.cournoyer@gmail.com Received: via spool by submit@debbugs.gnu.org id=B.169798056321248 (code B ref -1); Sun, 22 Oct 2023 13:17:02 +0000 Received: (at submit) by debbugs.gnu.org; 22 Oct 2023 13:16:03 +0000 Received: from localhost ([127.0.0.1]:45634 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1quYJG-0005We-JL for submit@debbugs.gnu.org; Sun, 22 Oct 2023 09:16:03 -0400 Received: from lists.gnu.org ([2001:470:142::17]:42166) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1quYJE-0005WA-0k for submit@debbugs.gnu.org; Sun, 22 Oct 2023 09:16:01 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1quYIe-00024I-M4 for guix-patches@gnu.org; Sun, 22 Oct 2023 09:15:24 -0400 Received: from mail-vk1-xa33.google.com ([2607:f8b0:4864:20::a33]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1quYIb-0006jr-9z for guix-patches@gnu.org; Sun, 22 Oct 2023 09:15:24 -0400 Received: by mail-vk1-xa33.google.com with SMTP id 71dfb90a1353d-49e1ef0c60dso987837e0c.1 for ; Sun, 22 Oct 2023 06:15:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1697980520; x=1698585320; darn=gnu.org; h=content-transfer-encoding:mime-version:message-id:date:subject:to :from:from:to:cc:subject:date:message-id:reply-to; bh=s8JxovA2MZBxRtbOSRf3wMoyfXRchFxNZ3YyIs/L2DA=; b=ZOdDBSt9eJMQKVSailQWbGy8SbizJHzbo1JbVjkHCoq3dhVfaYkDHukhGaLZ5BZhO6 i3gM0qMy7NJttEslL8/cJ2trUAtSZn8MaqksAVyPsqTYqGInqrpc1WlbtRm015FZXgov XUnW+1Na1Nnlh5M8pLDJSeZegSfokZlDYDgjIqHyeUCB+FfiSgffkjszN1Zmt49pQvHR q33fzMp+1+vGXG7I/PuMNJM6gJ7mbtdMVl0SYKWzGSmgyIV1NfsonD7EFquLy1qcN+zf jGBQ8/+ktLir0Q2yWh+ZyN7iQ3Df+8ocfWE4OzsSbvQLzx8kdijgoRpaWtMFvs+zj7+D R2+w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1697980520; x=1698585320; h=content-transfer-encoding:mime-version:message-id:date:subject:to :from:x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=s8JxovA2MZBxRtbOSRf3wMoyfXRchFxNZ3YyIs/L2DA=; b=d6hv6Gp6q5zTNaB0lO+IYL7E8daIO8x4iSZYfyiVWBY0gzmxy8TU/gf3p+ZX44z+Y9 CzYkeE0qTowuL0BTKSHuf+tGh3hV+4RiSssEd3BNv9cILvXstfD1uja1IOyr+EFq73Fh Ii0HFcVC0jZy4uNbZxnnHJwurBtGm3bqEpFBx2Trfpw1nqZ3EA/40ObaWXTB2zd3DWfj NawZPNR3UNoq0yKdrJCbzsSyOm0bi8800eHMUuPMRpqtLuAmK9hwzlyDVQHJjW0i+6AQ byiNgQjOwDpI5+nlcZouqDDAgtC851Px20APzCZcMqFirnyfAL0oXashq9zTAVjaqhpS Y5ag== X-Gm-Message-State: AOJu0YwRHLA35oDl0ohob7EnMAqSx8PWV88qoKA/MUgxaR9esglKJJ9t rm7UB8oXResYvy7HTw/qmlaMPfpjso8= X-Google-Smtp-Source: AGHT+IED6XZgzY4gzikh9jVcOtCfG30pXlWPiG3VmYbfMAiapZugf2M3Fo38yQBJ83I650i8jFbPBw== X-Received: by 2002:a67:cb92:0:b0:457:d691:b2f0 with SMTP id h18-20020a67cb92000000b00457d691b2f0mr5803731vsl.31.1697980519675; Sun, 22 Oct 2023 06:15:19 -0700 (PDT) Received: from localhost.localdomain (dsl-205-236-230-191.b2b2c.ca. [205.236.230.191]) by smtp.gmail.com with ESMTPSA id w20-20020a05620a149400b0076cbcf8ad3bsm2006997qkj.55.2023.10.22.06.15.18 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sun, 22 Oct 2023 06:15:19 -0700 (PDT) From: Maxim Cournoyer Date: Sun, 22 Oct 2023 09:15:04 -0400 Message-ID: <54f0a61d14743718e83abde603e7ec5b88af7c31.1697980504.git.maxim.cournoyer@gmail.com> X-Mailer: git-send-email 2.41.0 MIME-Version: 1.0 Received-SPF: pass client-ip=2607:f8b0:4864:20::a33; envelope-from=maxim.cournoyer@gmail.com; helo=mail-vk1-xa33.google.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * doc/contributing.texi (Tracking Bugs and Changes) : New subsection. Change-Id: Icead24ec18cd4511ee6217aae3c1d11ec552a9c7 --- doc/contributing.texi | 40 +++++++++++++++++++++++++++++++++++++++- 1 file changed, 39 insertions(+), 1 deletion(-) base-commit: e6af40d7b46b5c9e397a38c62c885fb42ccd9d26 diff --git a/doc/contributing.texi b/doc/contributing.texi index 864190b119..a11747c3c7 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -605,7 +605,7 @@ Packaging Guidelines * Version Numbers:: When the name is not enough. * Synopses and Descriptions:: Helping users find the right package. * Snippets versus Phases:: Whether to use a snippet, or a build phase. -* Cyclic Module Dependencies:: Going full circle. +* Cyclic Module Dependencies:: Going full circle. * Emacs Packages:: Your Elisp fix. * Python Modules:: A touch of British comedy. * Perl Modules:: Little pearls. @@ -1763,6 +1763,7 @@ Tracking Bugs and Changes * Managing Patches and Branches:: How changes to Guix are managed. * Debbugs User Interfaces:: Ways to interact with Debbugs. * Debbugs Usertags:: Tag reports with custom labels. +* Cuirass Build Notifications:: Be alerted of any breakage via RSS feeds. @end menu @node The Issue Tracker @@ -2012,6 +2013,43 @@ Debbugs Usertags consider updating this section of the manual so that others will know what your usertag means. +@node Cuirass Build Notifications +@subsection Cuirass Build Notifications + +@cindex build event notifications, RSS feed +@cindex notifications, build events +Cuirass, the software running on Berlin, one of the official build +servers, includes @acronym{RSS, Really Simple Syndication} feeds as one +of its features (@pxref{Notifications,,,cuirass}). This can be used to +keep track of recently broken or fixed packages caused by changes pushed +to the Guix git repository. Any RSS client can be used. A good one, +included with Emacs, is @xref{Gnus,,,gnus}. To register the feed, copy +its URL, then from the main Gnus buffer, @samp{*Group*}, do the +following: + +@cindex Gnus, configuration to read CI RSS feeds +@cindex RSS feeds, Gnus configuration +@example +@kbd{G R} https://ci.guix.gnu.org/events/rss/?specification=master RET +Guix CI - master RET Build events for specification master. RET +@end example + +@noindent +Then, back at the @samp{*Group*} buffer, press @kbd{s} to save the newly +added RSS group. As for any other Gnus group, you can update its +content by pressing the @kbd{g} key. You should now receive +notifications that read like: + +@example + . [ ?: Cuirass ] Build tree-sitter-meson.aarch64-linux on master is fixed. + . [ ?: Cuirass ] Build rust-pbkdf2.aarch64-linux on master is fixed. + . [ ?: Cuirass ] Build rust-pbkdf2.x86_64-linux on master is fixed. +@end example + +@noindent +where each RSS entry contains a link to the Cuirass build details page +of the associated build. + @node Commit Access @section Commit Access