quarkusio / registry.quarkus.io

Quarkus Extension Registry application
https://registry.quarkus.io
Apache License 2.0
10 stars 11 forks source link

Support patching an extension release's metadata #176

Closed gastaldi closed 1 year ago

gastaldi commented 1 year ago

/cc @holly-cummins

holly-cummins commented 1 year ago

@gastaldi, do you think it's worth updating the metadata with an extra field to say 'this has been patched' when we do the patch? I'm imagining myself staring at what's coming back from the registry, and then staring at what's in github, and scratching my head trying to figure out why they don't match. I think including a full audit trail of what-changed-and-when in the metadata of the extension would be overkill, but maybe some indicator that this was patched data would be useful.

gastaldi commented 1 year ago

@holly-cummins each entity has a createdAt attribute. We could have an updatedAt field and return both in the metadata when requested. WDYT?

holly-cummins commented 1 year ago

@holly-cummins each entity has a createdAt attribute. We could have an updatedAt field and return both in the metadata when requested. WDYT?

If an extension did a new release, would it change the 'createdAt' or 'updatedAt' field? I really like the idea of using these fields, but we might need three to fully capture the different variations of 'came into existence', 'had a release and was updated by the normal channels,' and 'was patched at midnight by cowboys'.

holly-cummins commented 1 year ago

s/cowboys/responsible, pragmatic, software engineers/ :)

gastaldi commented 1 year ago

If an extension did a new release, would it change the 'createdAt' or 'updatedAt' field?

It would be a new entry in the extension_release table, so yes, that would have different values

holly-cummins commented 1 year ago

Of course, I forgot that the schema tracks releases, not extensions. Ok, that sounds like a solid plan, then, @gastaldi.

gastaldi commented 1 year ago

@holly-cummins I'll merge this one and investigate the auditing requirements in a separate issue/PR