This repository has been archived by the owner on Jan 9, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
feat: set component versions to 0.1.0-alpha #59
Merged
jvallesm
merged 3 commits into
main
from
jvalles/ins-3620-add-version-to-existing-components
Feb 9, 2024
Merged
feat: set component versions to 0.1.0-alpha #59
jvallesm
merged 3 commits into
main
from
jvalles/ins-3620-add-version-to-existing-components
Feb 9, 2024
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #59 +/- ##
=======================================
Coverage 67.93% 67.93%
=======================================
Files 6 6
Lines 658 658
=======================================
Hits 447 447
Misses 168 168
Partials 43 43
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
✅ QA
curl --request GET \
--url 'localhost:8080/vdp/v1beta/operator-definitions?view=VIEW_BASIC' \
--header 'accept: application/json' \
--header 'Authorization: Bearer $INSTILL_KEY' | jq
% Total % Received % Xferd Average Speed Time Time Time Current
Dload Upload Total Spent Left Speed
100 3841 0 3841 0 0 136k 0 --:--:-- --:--:-- --:--:-- 138k
{
"operator_definitions": [
{
"name": "operator-definitions/base64",
"uid": "3a836447-c211-4134-9cc5-ad45e1cc467e",
"id": "base64",
"title": "Base64",
"documentation_url": "https://www.instill.tech/docs/latest/vdp/operators/base64",
"icon": "Instill AI/base64.svg",
"spec": null,
"tombstone": false,
"public": true,
"custom": false,
"source_url": "github.com/instill-ai/operator/blob/main/pkg/base64/v1",
"version": "1.0.0-alpha",
"tasks": [
{
"name": "TASK_ENCODE",
"title": "Encode",
"description": "Encode data into base64 string"
},
{
"name": "TASK_DECODE",
"title": "Decode",
"description": "Decode the base64 string."
}
]
},
{
"name": "operator-definitions/start",
"uid": "2ac8be70-0f7a-4b61-a33d-098b8acfa6f3",
"id": "start",
"title": "Start",
"documentation_url": "https://www.instill.tech/docs/latest/vdp/operators/op-start",
"icon": "Instill AI/start.svg",
"spec": null,
"tombstone": false,
"public": true,
"custom": false,
"source_url": "github.com/instill-ai/operator/blob/main/pkg/start/v1",
"version": "1.0.0-alpha",
"tasks": [
{
"name": "TASK_START",
"title": "Start",
"description": ""
}
]
},
...
} |
Include changes to display new definition fields in the VIEW_BASIC view in the component definition list
ec6c8d5
to
37a2346
Compare
donch1989
approved these changes
Feb 9, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
donch1989
pushed a commit
that referenced
this pull request
Feb 16, 2024
🤖 I have created a release *beep* *boop* --- ## [0.8.0-beta](v0.7.0-beta...v0.8.0-beta) (2024-02-16) ### Features * implement jq task in JSON operator ([#61](#61)) ([f38cd90](f38cd90)) * **json:** use `semi-structured/json` in TASK_MARSHAL and TASK_UNMARSHAL ([#62](#62)) ([acbe2db](acbe2db)) * set component versions to 0.1.0-alpha ([#59](#59)) ([80df32e](80df32e)) * store icons next to the component definition ([#58](#58)) ([9fea343](9fea343)) --- 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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
This commit
version
field to the component definition. Initial version is0.1.0-alpha
as we don't have a way to migrate components at the moment andthus we can't guarantee that we won't introduce more breaking changes.
v0
directory so more than one majorversion can coexist.
source_url
field in the component definition. This field isrequired by the component page and will be returned in the connector /
operator definition list.
Notes
Adding the
source_url
field in the definition isn't great as it references aparticular branch (in the
blob/main
bit) and because writing it by handshouldn't be required. It would be great if we could just build it from the
component ID but several connectors (e.g.
gcp
orinstill-model
) don't matchthe package and the ID. Also, there's no clean way to build this value and
inject it into the
Load[Connector|Operator]Definitions
function.To make the definitions file easier to build and less error-prone, we should
introduce a linter and perhaps a boilerplate builder in the future.
🤖 Script to migrate to v0