feat(compogen): use jsonref when generating the README #99
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
donch1989
force-pushed
the
huitang/ins-4293
branch
from
43a96e8
to
90f1cd7
Compare
donch1989
requested review from
pinglin,
xiaofei-du and
jvallesm
as code owners
jvallesm
requested changes
Apr 24, 2024
There was a problem hiding this comment.
Thanks for taking care of this 💛
A couple of changes are required:
- The tests aren't passing with these changes, they need to be updated
- It'd be good to add a GHA for this package using
make test
- It'd be good to add a GHA for this package using
- We need to add the generation tags to the components that can have autogenerated documentation. That way, the integration action Naman is working on will take them into account.
If you prefer it, I can have a look at this items and contribute to this branch.
| @@ -14,6 +14,6 @@ type property struct { | |||
| } | |||
|
|
|||
| type objectSchema struct { | |||
| Properties map[string]property `json:"properties" validate:"gt=0,dive"` | |||
| Properties map[string]property `json:"properties" validate:"dive"` | |||
There was a problem hiding this comment.
I'd rather avoid empty objects in the definitions and keep this validation but if that's not possible I'm fine with loosening the restrictions. Did you encounter any other case with empty object schemas apart from resource_specification?
There was a problem hiding this comment.
The Instill Model connector will encounter some issues with this (I guess it is caused by oneof). However, we are also discussing removing the "external mode" for the Instill Model connector. The problem will be resolved if we decide to remove it.
There was a problem hiding this comment.
Thanks for looking into it 🙇 In order not to be blocked by the removal of external mode, I'd remove the gt=0 validation with a TODO comment
Because - `compogen` tests are broken This commit - fixes tests - adds action to check `compogen` when changed
jvallesm
approved these changes
Apr 24, 2024
donch1989
pushed a commit
that referenced
this pull request
Apr 25, 2024
🤖 I have created a release *beep* *boop* --- ## [0.15.0-beta](v0.14.1-beta...v0.15.0-beta) (2024-04-25) ### Features * add `UsageHandler` interface ([#87](#87)) ([b9d9645](b9d9645)) * adjust `IConnector` interface ([#83](#83)) ([46ea796](46ea796)) * adjust `Test()` interface ([#81](#81)) ([763cc6d](763cc6d)) * adopt system variables ([#92](#92)) ([e8ae4e1](e8ae4e1)) * expose `IsCredentialField` interface ([#93](#93)) ([6cd2801](6cd2801)) * merge resource spec into component spec ([#86](#86)) ([a6de70e](a6de70e)) * **airbyte:** remove Airbyte connectors ([#88](#88)) ([ec770d6](ec770d62cf52fa099a9be6825432d76f0d211f4a))* * **compogen:** use jsonref when generating the README ([#99](#99)) ([ff49157](ff49157)) * **instill:** drop support for "external mode" ([#101](#101)) ([b0c091b](b0c091b)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
namwoam
pushed a commit
to namwoam/component
that referenced
this pull request
Jun 24, 2024
Because - The `compogen` tool didn't use `jsonref` to render the definition, some component readme cannot be generated. This commit - Uses `jsonref` when generating the README. - Renames `resource_specification` to `connection_specification`. - Removes the validation for an empty `connection_specification`. Note - We still do not support nested structures yet. --------- Co-authored-by: Juan Vallés <3977183+jvallesm@users.noreply.github.com> Co-authored-by: Juan Vallés <jvallesm@gmail.com>
namwoam
pushed a commit
to namwoam/component
that referenced
this pull request
Jun 24, 2024
🤖 I have created a release *beep* *boop* --- ## [0.15.0-beta](instill-ai/component@v0.14.1-beta...v0.15.0-beta) (2024-04-25) ### Features * add `UsageHandler` interface ([instill-ai#87](instill-ai#87)) ([b9d9645](instill-ai@b9d9645)) * adjust `IConnector` interface ([instill-ai#83](instill-ai#83)) ([46ea796](instill-ai@46ea796)) * adjust `Test()` interface ([instill-ai#81](instill-ai#81)) ([763cc6d](instill-ai@763cc6d)) * adopt system variables ([instill-ai#92](instill-ai#92)) ([e8ae4e1](instill-ai@e8ae4e1)) * expose `IsCredentialField` interface ([instill-ai#93](instill-ai#93)) ([6cd2801](instill-ai@6cd2801)) * merge resource spec into component spec ([instill-ai#86](instill-ai#86)) ([a6de70e](instill-ai@a6de70e)) * **airbyte:** remove Airbyte connectors ([instill-ai#88](instill-ai#88)) ([ec770d6](instill-ai@ec770d62cf52fa099a9be6825432d76f0d211f4a))* * **compogen:** use jsonref when generating the README ([instill-ai#99](instill-ai#99)) ([ff49157](instill-ai@ff49157)) * **instill:** drop support for "external mode" ([instill-ai#101](instill-ai#101)) ([b0c091b](instill-ai@b0c091b)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Because
compogentool didn't usejsonrefto render the definition, some component readme cannot be generated.This commit
jsonrefwhen generating the README.resource_specificationtoconnection_specification.connection_specification.Note