Support for use of crdify as a go library

[crenshaw-dev]

Apologies if this is documented, and I've just missed it...

Is crdify meant to be usable as a go library by other go tools? I've used it this way in one project, and I think there would be interest in other projects such as KRO. Are there plans to keep a stable go API for such use cases?

[everettraven]

@crenshaw-dev Yep! The intention is that this can be used as both a Go library and an explicit CLI tool. How you've used it is exactly how I'd recommend it is used as a package. Another good example is it's use in OLM v1 preflight checks for CRD compatibility

For now, the plan is to keep the Go API as stable as possible and follow the versioning semantics of Go packages. Some good info on this: https://go.dev/doc/modules/version-numbers

As this project is still fairly early in it's lifecycle I suspect there may be some breaking changes in the Go API as adoption grows and new needs arise, but for now I think the main entry point is pretty solid and shouldn't see much churn.

I suspect it will be a while before an official v1.0.0 comes out for this project and based on the versioning semantics for Go, a package in v0.Y.Z has no stability or backwards compatibility guarantees giving us flexibility where we may need it until a stable release is made.

[crenshaw-dev]

That's great to hear! Would it be helpful if I opened a docs PR expressing basically what you've said here? Also fine to just leave it in this issue if that's preferable.

[everettraven]

Happy to accept a PR to make the usage documentation more explicit :)

[jakobmoellerdev]

Hey there folks, checking in on behalf of KRO here. We went through the go mod and particularly have some issue with pulling in git-go / the loading infrastructure. do you think we could make the validators work independently?

[everettraven]

I'm not opposed to having a separation of functionality there but would have to think through mechanics of that a bit more.

I haven't had much time recently to focus on this project, but I'm hoping to carve out more time more consistently as the year comes to a close and the start of the new year.

As with the documentation updates on using it as a library, I'm happy to review any PRs as I've got time to do so.

[everettraven]

@jakobmoellerdev Would you mind opening a new issue to track any discussions related to separate go.mod there?