--- Begin Message ---
|
Subject: |
[PATCH] doc: Document Cuirass build notifications. |
|
Date: |
Sun, 22 Oct 2023 09:15:04 -0400 |
* doc/contributing.texi (Tracking Bugs and Changes)
<Cuirass Build Notifications>: New subsection.
Change-Id: Icead24ec18cd4511ee6217aae3c1d11ec552a9c7
---
doc/contributing.texi | 40 +++++++++++++++++++++++++++++++++++++++-
1 file changed, 39 insertions(+), 1 deletion(-)
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
base-commit: e6af40d7b46b5c9e397a38c62c885fb42ccd9d26
--
2.41.0
--- End Message ---
--- Begin Message ---
|
Subject: |
Re: [bug#66681] [PATCH] doc: Document Cuirass build notifications. |
|
Date: |
Mon, 23 Oct 2023 11:45:06 -0400 |
|
User-agent: |
Gnus/5.13 (Gnus v5.13) |
Hi Mathieu,
Mathieu Othacehe <othacehe@gnu.org> writes:
> Hello Maxim,
>
>> +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
>
> I think it is worth mentioning that any deployed Cuirass installation
> will offer RSS support, because the above statement can make people
> think that only the Berlin instance does.
>
> Otherwise it looks good to me :)
I've rephrased the first sentence to hopefully remove any ambiguity.
See cbd20d6274.
--
Thanks,
Maxim
--- End Message ---