branch master updated: doc: Document Cuirass build notifications.

[guix-commits]

This is an automated email from the git hooks/post-receive script.

apteryx pushed a commit to branch master
in repository guix.

The following commit(s) were added to refs/heads/master by this push:
     new cbd20d6274 doc: Document Cuirass build notifications.
cbd20d6274 is described below

commit cbd20d627497053871db863970c07d93c7081786
Author: Maxim Cournoyer <maxim.cournoyer@gmail.com>
AuthorDate: Sat Oct 21 21:45:43 2023 -0400

    doc: Document Cuirass build notifications.
    
    * doc/contributing.texi (Tracking Bugs and Changes)
    <Cuirass Build Notifications>: New subsection.
    
    Change-Id: Icead24ec18cd4511ee6217aae3c1d11ec552a9c7
    Reviewed-by: Mathieu Othacehe <othacehe@gnu.org>
---
 doc/contributing.texi | 40 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 39 insertions(+), 1 deletion(-)

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 43cfae26c4..ac7f8d2e0f 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -605,7 +605,7 @@ needed is to review and apply the patch.
 * 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.
@@ -1771,6 +1771,7 @@ patch submissions and topic branches.
 * 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
@@ -2020,6 +2021,43 @@ with the @code{guix} user.  If the usertag proves useful 
to you,
 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 includes @acronym{RSS, Really Simple Syndication} feeds as one
+of its features (@pxref{Notifications,,,cuirass}).  Since
+@url{https://ci.guix.gnu.org/, Berlin} runs an instance of Cuirass, this
+feature 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