Andrea Peruffo

Results 396 comments of Andrea Peruffo

One possible trade-off is to enable one of these tools in the build but don't run it automatically. We can tighten things up with a GH action check to verify...

Hi @jsenko ! I took a stab at generating such documentation using `jbang` and `jandex`. Here you have a very very draft: https://github.com/Apicurio/apicurio-registry/commit/fcad909cbae589ffc4c4e8f7e163fc7464fda1e6 The current result can be seen here:...

- added to my prototype the "automatic extraction" of "Available From" - leaving `RegistryProperties` with the current "best-effort" You can see the result here: https://github.com/andreaTP/apicurio-registry/blob/generate-config-docs/out.md Please, play a little with...

Getting back to this, I think that my automatic extraction of "available since" is too much complexity/tech debt for such a simple thing (also my implementation won't work for versions...

> Could we generate a JSON formatted index of properties for every version Of course, where should we store it? Can it also feed the final documentation? Automating "available since"...

> As an asset for each release. Part of the release automation would be to compare with the asset in the previous release. Not unreasonable, but I think that is...

Started: https://github.com/Apicurio/apicurio-common-app-components/pull/44 as a baseline and: https://github.com/Apicurio/apicurio-registry/pull/2715 to show the possible outcome.

> Should we have validation that we've annotated all usages of that with the new `@Info` annotation? The "quick and dirty" check would be to include the doc generation in...

Thanks for chipping in @smccarthy-ie ! Technically, if we need to distinguish such properties, we can do it with an additional flag in the `@Info` annotation. But, let's see what...

A possible solution would be to produce a standalone CLI that can eventually run in CI, hacked around a POC here to receive early comments: https://github.com/Apicurio/apicurio-codegen/pull/37