Proposal for machine-readable contact info for spins maintainers

[Matthew Miller]

Background: we want to notify spin maintainers when their particular
  compose fails. Specifically, tag them in the ticket so they get notified.

  (We could also possibly do email notifications or something else, but that
  gets into the general problem of "sending automated email sucks", so for
  first pass, tagging people in the pagure repo seems good.)

  Related ticket: https://pagure.io/releng/compose-tracker/issue/4

Problem: there's no consistent machine-readable source of truth for who to
  tag. Maintainer information is found in comments in the various kickstarts
  in https://pagure.io/fedora-kickstarts/tree/master, but it's not in a
  consistent format, and is sometimes a group mailing list rather than a FAS
  ID.

Two competing proposals

  Proposal A: make that header information consistent and required, with a
    format like:

      # SPIN-Maintainer-IDs: mattdm, mboddu
      # SPIN-Maintainer-Names: Matthew Miller, Mohan Bodhu
      # SPIN-Mailing-List: fedora-imaginaryimage(a)fedoraproject.org

    or something like that.

  Proposal B: remove maintainer info from unstructured comments, introduce
    new "maintainers.toml" file. (Because Of Course It Does, compose-tracker
    uses both Toml and Yaml. I've been playing with Rust lately, so I
    arbitrarily pick Toml.

     [spins]

      [spins.imaginary]
      fas = [ "mattdm", "mboddu" ]
      maintainers = [ "Matthew Miller", "Mohan Bodhu" ]

    or something like that. I'm just making this up as I type.   

Thoghts?


-- 
Matthew Miller
<mattdm(a)fedoraproject.org&gt;
Fedora Project Leader

[Dennis Gilmore]

+1000 make it happen.

Dennis

On Thu, Feb 13, 2020, 15:31 Matthew Miller <mattdm(a)fedoraproject.org&gt; wrote:

>  Background: we want to notify spin maintainers when their particular
>    compose fails. Specifically, tag them in the ticket so they get notified.
>
>    (We could also possibly do email notifications or something else, but
>  that
>    gets into the general problem of "sending automated email sucks", so for
>    first pass, tagging people in the pagure repo seems good.)
>
>    Related ticket: https://pagure.io/releng/compose-tracker/issue/4
>
>  Problem: there's no consistent machine-readable source of truth for who to
>    tag. Maintainer information is found in comments in the various
>  kickstarts
>    in https://pagure.io/fedora-kickstarts/tree/master, but it's not in a
>    consistent format, and is sometimes a group mailing list rather than a
>  FAS
>    ID.
>
>  Two competing proposals
>
>    Proposal A: make that header information consistent and required, with a
>      format like:
>
>        # SPIN-Maintainer-IDs: mattdm, mboddu
>        # SPIN-Maintainer-Names: Matthew Miller, Mohan Bodhu
>        # SPIN-Mailing-List: fedora-imaginaryimage(a)fedoraproject.org
>
>      or something like that.
>
>    Proposal B: remove maintainer info from unstructured comments, introduce
>      new "maintainers.toml" file. (Because Of Course It Does,
>  compose-tracker
>      uses both Toml and Yaml. I've been playing with Rust lately, so I
>      arbitrarily pick Toml.
>
>       [spins]
>
>        [spins.imaginary]
>        fas = [ "mattdm", "mboddu" ]
>        maintainers = [ "Matthew Miller", "Mohan Bodhu" ]
>
>      or something like that. I'm just making this up as I type.
>
>  Thoghts?
>
>
>  --
>  Matthew Miller
>  <mattdm(a)fedoraproject.org&gt;
>  Fedora Project Leader
>  _______________________________________________
>  spins mailing list -- spins(a)lists.fedoraproject.org
>  To unsubscribe send an email to spins-leave(a)lists.fedoraproject.org
>  Fedora Code of Conduct:
>  https://docs.fedoraproject.org/en-US/project/code-of-conduct/
>  List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
>  List Archives:
>  https://lists.fedoraproject.org/archives/list/[e-mail]
>

[Erich Eickmeyer]

Hi Matthew,

On Thu, Feb 13, 2020 at 4:30 pm, Matthew Miller 
<mattdm(a)fedoraproject.org&gt; wrote:
>  Background: we want to notify spin maintainers when their particular
>    compose fails. Specifically, tag them in the ticket so they get 
>  notified.
>  
>    (We could also possibly do email notifications or something else, 
>  but that
>    gets into the general problem of "sending automated email sucks", 
>  so for
>    first pass, tagging people in the pagure repo seems good.)
>  
>    Related ticket: <https://pagure.io/releng/compose-tracker/issue/4>
>  
>  Problem: there's no consistent machine-readable source of truth for 
>  who to
>    tag. Maintainer information is found in comments in the various 
>  kickstarts
>    in <https://pagure.io/fedora-kickstarts/tree/master>;, but it's not 
>  in a
>    consistent format, and is sometimes a group mailing list rather 
>  than a FAS
>    ID.
>  
>  Two competing proposals
>  
>    Proposal A: make that header information consistent and required, 
>  with a
>      format like:
>  
>        # SPIN-Maintainer-IDs: mattdm, mboddu
>        # SPIN-Maintainer-Names: Matthew Miller, Mohan Bodhu
>        # SPIN-Mailing-List: fedora-imaginaryimage(a)fedoraproject.org 
>  <mailto:[e-mail]>
>  
>      or something like that.
>  
>    Proposal B: remove maintainer info from unstructured comments, 
>  introduce
>      new "maintainers.toml" file. (Because Of Course It Does, 
>  compose-tracker
>      uses both Toml and Yaml. I've been playing with Rust lately, so I
>      arbitrarily pick Toml.
>  
>       [spins]
>  
>        [spins.imaginary]
>        fas = [ "mattdm", "mboddu" ]
>        maintainers = [ "Matthew Miller", "Mohan Bodhu" ]
>  
>      or something like that. I'm just making this up as I type.
>  
>  Thoghts?
>   
Whatever implementation happens would be great. In the Ubuntu world, we 
have something similar where if a particular "flavor" fails to spin, 
then the development groups for those flavors are notified via email. I 
was noticing there was no such notification when taking over Jam, so I 
didn't even know where to look to fix the kickstart at first. So, I 
think any sort of notification to this effect would be invaluable.

Additionally, I believe something like this would prevent spins from 
being outright abandoned as it would make it difficult to ignore a 
daily email that a spin is failing. At least then the maintainer would 
be more likely to want to hand it off as opposed to simply abandoning 
it.

Just my 2c.
Erich
---
Erich Eickmeyer
Fedora Jam Maintainer

[Kevin Fenzi]

On Thu, Feb 13, 2020 at 04:30:55PM -0500, Matthew Miller wrote:
>  Background: we want to notify spin maintainers when their particular
>    compose fails. Specifically, tag them in the ticket so they get notified. 
+100 on the idea. :) 

On implementation, what about extending pungi config to have this info,
and then we just put it in with the pungi-fedora config for that
spin/lab/whatever. This would have the advantage of putting it in the
same place as where it's defined that we make it, and we could also
hopefully add this info to things like the armv7 images or whatever
other deliverables we want to notify someone on. 

ie, 

            {
                'name': 'Fedora-Xfce-Live',
                'kickstart': 'fedora-live-xfce.ks',
                'arches': ['x86_64'],
                'failable': ['*'],
                'repo': 'Everything',
                'install_tree_from': 'Everything',
                'subvariant': 'Xfce'
            },

becomes:

            {
                'name': 'Fedora-Xfce-Live',
                'maintainers': ['kevin', 'nonamedotc'], 
                'maintainer_list': 'xfce(a)lists.fedoraproject.org', 
                'kickstart': 'fedora-live-xfce.ks',
                'arches': ['x86_64'],
                'failable': ['*'],
                'repo': 'Everything',
                'install_tree_from': 'Everything',
                'subvariant': 'Xfce'
            },

etc...

kevin

[Ben Cotton]

On Thu, Feb 13, 2020 at 5:48 PM Kevin Fenzi <kevin(a)scrye.com&gt; wrote:
>  On Thu, Feb 13, 2020 at 04:30:55PM -0500, Matthew Miller wrote:
>  > Background: we want to notify spin maintainers when their particular
>  >   compose fails. Specifically, tag them in the ticket so they get notified.
>
>  +100 on the idea. :)
>
>  On implementation, what about extending pungi config to have this info,
>  and then we just put it in with the pungi-fedora config for that
>  spin/lab/whatever. This would have the advantage of putting it in the
>  same place as where it's defined that we make it, and we could also
>  hopefully add this info to things like the armv7 images or whatever
>  other deliverables we want to notify someone on.
>  
I like this implementation proposal. The fewer places we define
authoritative information, the easier life becomes on everyone.

-- 
Ben Cotton
He / Him / His
Senior Program Manager, Fedora & CentOS Stream
Red Hat
TZ=America/Indiana/Indianapolis

[Ankur Sinha]

On Thu, Feb 13, 2020 20:05:50 -0500, Ben Cotton wrote:
>  On Thu, Feb 13, 2020 at 5:48 PM Kevin Fenzi <kevin(a)scrye.com&gt;
> wrote:
>  >
>  > On Thu, Feb 13, 2020 at 04:30:55PM -0500, Matthew Miller wrote:
>  > > Background: we want to notify spin maintainers when their particular
>  > >   compose fails. Specifically, tag them in the ticket so they get notified.
>  >
>  > +100 on the idea. :)
>  >
>  > On implementation, what about extending pungi config to have this info,
>  > and then we just put it in with the pungi-fedora config for that
>  > spin/lab/whatever. This would have the advantage of putting it in the
>  > same place as where it's defined that we make it, and we could also
>  > hopefully add this info to things like the armv7 images or whatever
>  > other deliverables we want to notify someone on.
>  >
>  I like this implementation proposal. The fewer places we define
>  authoritative information, the easier life becomes on everyone.
>   
+1 too! This would be awesome.

-- 
Thanks,
Regards,
Ankur Sinha "FranciscoD" (He / Him / His) |
https://fedoraproject.org/wiki/User:Ankursinha
Time zone: Europe/London

[Matthew Miller]

On Fri, Feb 14, 2020 at 11:15:21AM +0000, Ankur Sinha wrote:
>  > > On implementation, what about extending pungi config to
> have this info,
>  > > and then we just put it in with the pungi-fedora config for that
>  > I like this implementation proposal. The fewer places we define
>  > authoritative information, the easier life becomes on everyone.
>  +1 too! This would be awesome. 
Sure, this'll work. I don't really care about the implementation. :)

-- 
Matthew Miller
<mattdm(a)fedoraproject.org&gt;
Fedora Project Leader

[Mohan Boddu]

This is great idea but it also means that pungi has to understand the new properties like
"maintainers" and "maintainer_list" or learn to ignore them. Also,
spin maintainers are used to creating PR's to fedora-kickstarts, if we ask them to
update pungi configs thats another repo that they have to follow. And when we have to
parse them if they part of pungi configs means, adding kobo as the requirement which I
would like to avoid for such a simple thing as this. And coming to armv7 images and stuff,
if we go with Proposal B from mattdm, we can still add people who would like to get
notified for images that they are interested in. wdyt?

[Dan Book]

Setting the maintainers for a spin should generally not be something that
needs to be updated that often, personally I am fine with however it is
most useful to set up.

-Dan

On Thu, Feb 20, 2020 at 12:02 PM Mohan Boddu <mboddu(a)bhujji.com&gt; wrote:

>  This is great idea but it also means that pungi has to understand the
> new
>  properties like "maintainers" and "maintainer_list" or learn to
> ignore
>  them. Also, spin maintainers are used to creating PR's to
>  fedora-kickstarts, if we ask them to update pungi configs thats another
>  repo that they have to follow. And when we have to parse them if they part
>  of pungi configs means, adding kobo as the requirement which I would like
>  to avoid for such a simple thing as this. And coming to armv7 images and
>  stuff, if we go with Proposal B from mattdm, we can still add people who
>  would like to get notified for images that they are interested in. wdyt?
>  _______________________________________________
>  spins mailing list -- spins(a)lists.fedoraproject.org
>  To unsubscribe send an email to spins-leave(a)lists.fedoraproject.org
>  Fedora Code of Conduct:
>  https://docs.fedoraproject.org/en-US/project/code-of-conduct/
>  List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
>  List Archives:
>  https://lists.fedoraproject.org/archives/list/[e-mail]
>

[Kevin Fenzi]

On Thu, Feb 20, 2020 at 05:02:42PM -0000, Mohan Boddu wrote:
>  This is great idea but it also means that pungi has to understand the
> new properties
>  like "maintainers" and "maintainer_list" or learn to ignore them.
> Also, spin maintainers 
Yeah, I filed a pungi issue on that... I'm sure it's doable... but... 

>  are used to creating PR's to fedora-kickstarts, if we ask them to
> update pungi configs
>  thats another repo that they have to follow. And when we have to parse them if they part
>  of pungi configs means, adding kobo as the requirement which I would like to avoid for
>  such a simple thing as this. And coming to armv7 images and stuff, if we go with
> Proposal
>  B from mattdm, we can still add people who would like to get notified for images that
> they are interested in. wdyt? 
Sure, I guess it makes more sense to keep it in the fedora-kickstarts
repo, in some format thats easily parseable/readable. 

kevin