[gentoo-dev] Proposal for a Universal Remote-ID File

[gentoo-dev] Proposal for a Universal Remote-ID File

[Siddhanth Rathod]

[-- Attachment #1: Type: text/plain, Size: 674 bytes --]

I'm writing to propose the creation of a universal remote-ID file within 
the api.git or gentoo.git in the metadata/ directory. Currently, we have 
eight different locations that require manual updates for any future 
changes, including my recent commit 
(https://gitweb.gentoo.org/proj/gentoolkit.git/commit/?id=5146d35eb97e2c1a8f7691e59c755ed14e858dd4) 
to gentoolkit and the rest seven as mentioned here 
https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Upstream_remote-id_types.

By establishing a universal remote-ID file, we can streamline this 
process. Your thoughts and feedback on this proposal would be greatly 
appreciated.Also, Any preferences on format?

[-- Attachment #2: Type: text/html, Size: 1240 bytes --]

Re: [gentoo-dev] Proposal for a Universal Remote-ID File

[Ulrich Mueller]

[-- Attachment #1: Type: text/plain, Size: 1183 bytes --]

>>>>> On Fri, 22 Sep 2023, Siddhanth Rathod wrote:

> I'm writing to propose the creation of a universal remote-ID file
> within the api.git or gentoo.git in the metadata/ directory.
> Currently, we have eight different locations that require manual
> updates for any future changes, including my recent commit
> (https://gitweb.gentoo.org/proj/gentoolkit.git/commit/?id=5146d35eb97e2c1a8f7691e59c755ed14e858dd4)
> to gentoolkit and the rest seven as mentioned here
> https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Upstream_remote-id_types.

> By establishing a universal remote-ID file, we can streamline this
> process. Your thoughts and feedback on this proposal would be greatly
> appreciated.Also, Any preferences on format?

My preference would be a simple text file with a table, similar to
files/uid-gid.txt in api.git. Then we could just modify the existing
tooling to generate the wiki page form it, and wouldn't need any special
tools to create the other files.

Alternatively, it could be in XML. While I'm not a large fan of XML, it
seems a natural choice here, because metadata.xml, the DTD, and the XML
and Relax-NG schemas are all from the XML world.

Ulrich

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 507 bytes --]

Re: [gentoo-dev] Proposal for a Universal Remote-ID File

[Sam James]

[-- Attachment #1: Type: text/plain, Size: 1304 bytes --]


Ulrich Mueller <ulm@gentoo.org> writes:

> [[PGP Signed Part:Undecided]]
>>>>>> On Fri, 22 Sep 2023, Siddhanth Rathod wrote:
>
>> I'm writing to propose the creation of a universal remote-ID file
>> within the api.git or gentoo.git in the metadata/ directory.
>> Currently, we have eight different locations that require manual
>> updates for any future changes, including my recent commit
>> (https://gitweb.gentoo.org/proj/gentoolkit.git/commit/?id=5146d35eb97e2c1a8f7691e59c755ed14e858dd4)
>> to gentoolkit and the rest seven as mentioned here
>> https://wiki.gentoo.org/wiki/Project:Quality_Assurance/Upstream_remote-id_types.
>
>> By establishing a universal remote-ID file, we can streamline this
>> process. Your thoughts and feedback on this proposal would be greatly
>> appreciated.Also, Any preferences on format?
>
> My preference would be a simple text file with a table, similar to
> files/uid-gid.txt in api.git. Then we could just modify the existing
> tooling to generate the wiki page form it, and wouldn't need any special
> tools to create the other files.

Sounds ok.

>
> Alternatively, it could be in XML. While I'm not a large fan of XML, it
> seems a natural choice here, because metadata.xml, the DTD, and the XML
> and Relax-NG schemas are all from the XML world.
>
> Ulrich



[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 377 bytes --]

Re: [gentoo-dev] Proposal for a Universal Remote-ID File

[Michael Orlitzky]

On Sat, 2023-09-23 at 00:10 +0530, Siddhanth Rathod wrote:
> 
> By establishing a universal remote-ID file, we can streamline this 
> process. Your thoughts and feedback on this proposal would be greatly 
> appreciated.Also, Any preferences on format?

Building the wiki page isn't too hard, but what's the plan to propagate
changes into those seven other repositories? If we're still
copy/pasting the output of some tool, then we haven't really saved a
step, we've only changed what we're copy/pasting.

Re: [gentoo-dev] Proposal for a Universal Remote-ID File

[Sam James]

Michael Orlitzky <mjo@gentoo.org> writes:

> On Sat, 2023-09-23 at 00:10 +0530, Siddhanth Rathod wrote:
>> 
>> By establishing a universal remote-ID file, we can streamline this 
>> process. Your thoughts and feedback on this proposal would be greatly 
>> appreciated.Also, Any preferences on format?
>
> Building the wiki page isn't too hard, but what's the plan to propagate
> changes into those seven other repositories? If we're still
> copy/pasting the output of some tool, then we haven't really saved a
> step, we've only changed what we're copy/pasting.

At the moment, we bundle the DTD in pkgcore. If we just shoved it in
metadata/ instead in the main repo, we don't have that kind of problem.

Re: [gentoo-dev] Proposal for a Universal Remote-ID File

[Michael Orlitzky]

On Sat, 2023-09-23 at 15:39 +0100, Sam James wrote:
> 
> At the moment, we bundle the DTD in pkgcore. If we just shoved it in
> metadata/ instead in the main repo, we don't have that kind of problem.
> 

I might be missing something obvious, but what I mean is, suppose we
have this plain-text mapping of remote-id names to URLs. How do we get
the list of keys (valid remote-id names) into the DTD? Even if both
files are inside metadata/, there's another step that needs to happen.

Re: [gentoo-dev] Proposal for a Universal Remote-ID File

[Siddhanth Rathod]

[-- Attachment #1: Type: text/plain, Size: 588 bytes --]

How does modifying the DTD with a git hook sound ?

On 9/23/23 20:17, Michael Orlitzky wrote:
> On Sat, 2023-09-23 at 15:39 +0100, Sam James wrote:
>> At the moment, we bundle the DTD in pkgcore. If we just shoved it in
>> metadata/ instead in the main repo, we don't have that kind of problem.
>>
> I might be missing something obvious, but what I mean is, suppose we
> have this plain-text mapping of remote-id names to URLs. How do we get
> the list of keys (valid remote-id names) into the DTD? Even if both
> files are inside metadata/, there's another step that needs to happen.
>
>

[-- Attachment #2: Type: text/html, Size: 1140 bytes --]

Re: [gentoo-dev] Proposal for a Universal Remote-ID File

[Michael Orlitzky]

On Sun, 2023-09-24 at 23:14 +0530, Siddhanth Rathod wrote:
> How does modifying the DTD with a git hook sound ?

That could work if we put the DTD, XML schema, and RELAX NG schema all
in the repo metadata. The remaining projects are programs and (given
access to ::gentoo) can probably parse the list themselves.

We're all sufficiently clever here to imagine some solution; it just
occurred to me that without a concrete proposal, it's hard to say
whether the end result would actually be simpler than copy/paste.

Re: [gentoo-dev] Proposal for a Universal Remote-ID File

[Ionen Wolkens]

[-- Attachment #1: Type: text/plain, Size: 1310 bytes --]

On Sat, Sep 23, 2023 at 03:39:32PM +0100, Sam James wrote:
> 
> Michael Orlitzky <mjo@gentoo.org> writes:
> 
> > On Sat, 2023-09-23 at 00:10 +0530, Siddhanth Rathod wrote:
> >> 
> >> By establishing a universal remote-ID file, we can streamline this 
> >> process. Your thoughts and feedback on this proposal would be greatly 
> >> appreciated.Also, Any preferences on format?
> >
> > Building the wiki page isn't too hard, but what's the plan to propagate
> > changes into those seven other repositories? If we're still
> > copy/pasting the output of some tool, then we haven't really saved a
> > step, we've only changed what we're copy/pasting.
> 
> At the moment, we bundle the DTD in pkgcore. If we just shoved it in
> metadata/ instead in the main repo, we don't have that kind of problem.

Likewise for iwdevtools which I'd update for this myself, loading from
::gentoo would be pretty trivial beside a little bit overhead to find
the repo.

At worst does mean that remote-ids won't resolve if it didn't manage
the repo (it's optional) but that's entirely fine for that tool and
beats updating these manually + making a release almost just for that
constantly (or fetching files at runtime).

If this was stored elsewhere (e.g. api.git), then wouldn't gain much.
-- 
ionen

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]