Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: refactor package structure #140

Merged
merged 9 commits into from
May 27, 2024
Merged

feat: refactor package structure #140

merged 9 commits into from
May 27, 2024

Conversation

donch1989
Copy link
Member

@donch1989 donch1989 commented May 27, 2024

Because

  • In our new VDP recipe design, there is not much difference between connectors and operators, and the term "connector" doesn't provide useful information to the user. Therefore, we decided to flatten the component structure. The original connectors will be directly categorized into ai, data, and application components.

This commit

  • Modifies the folder structure to categorize connectors into ai, data, and application components.
  • Removes /pkg folder.

Note

  • In this PR, we only modify the folder structure. In the upcoming PRs, we'll further refactor the component interface to unify the connector and operator interfaces into one component interface.

Copy link

linear bot commented May 27, 2024

@donch1989 donch1989 marked this pull request as draft May 27, 2024 04:51
@donch1989 donch1989 marked this pull request as ready for review May 27, 2024 07:32
@donch1989
Copy link
Member Author

Note: The compogen test won't pass on CI because we need to update the hash for the component repository in go.mod.

Copy link
Collaborator

@jvallesm jvallesm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although I don't love having the base component.go file, overall the structure looks good.

This will affect the website documentation structure (and content, too), and the way auto-generated docs are loaded into instill.tech.

All comments are nice-to-haves

component.go Outdated Show resolved Hide resolved
component.go Outdated Show resolved Hide resolved
component.go Outdated Show resolved Hide resolved
component.go Outdated Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps we can ask @GeorgeWilliamStrong to proofread this, see if there are points where we can improve clarity.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
Copy link

codecov bot commented May 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.59%. Comparing base (4ce9851) to head (efef9d7).
Report is 44 commits behind head on main.

Current head efef9d7 differs from pull request most recent head 443f6fc

Please upload reports for the commit 443f6fc to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #140      +/-   ##
==========================================
+ Coverage   57.32%   58.59%   +1.26%     
==========================================
  Files          30       36       +6     
  Lines        3145     3437     +292     
==========================================
+ Hits         1803     2014     +211     
- Misses       1104     1157      +53     
- Partials      238      266      +28     
Flag Coverage Δ
unittests 58.59% <ø> (+1.26%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@donch1989
Copy link
Member Author

donch1989 commented May 27, 2024

This will affect the website documentation structure (and content, too), and the way auto-generated docs are loaded into instill.tech.

Yes, I'll update the website to adopt these changes.

Copy link
Collaborator

@jvallesm jvallesm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@donch1989 donch1989 merged commit 4853d4c into main May 27, 2024
8 of 9 checks passed
@donch1989 donch1989 deleted the huitang/ins-4463 branch May 27, 2024 10:52
chuang8511 pushed a commit that referenced this pull request May 28, 2024
Because

- In our new VDP recipe design, there is not much difference between
connectors and operators, and the term "connector" doesn't provide
useful information to the user. Therefore, we decided to flatten the
component structure. The original connectors will be directly
categorized into `ai`, `data`, and `application` components.

This commit

- Modifies the folder structure to categorize connectors into `ai`,
`data`, and `application` components.
- Removes `/pkg` folder.

Note

- In this PR, we only modify the folder structure. In the upcoming PRs,
we'll further refactor the component interface to unify the connector
and operator interfaces into one component interface.
donch1989 pushed a commit that referenced this pull request Jun 6, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.19.0-beta](v0.18.0-beta...v0.19.0-beta)
(2024-06-05)


### Features

* add pdf component
([#138](#138))
([517afcf](517afcf))
* add task chunk text
([#139](#139))
([7b36553](7b36553))
* **instill:** adopt latest Model endpoints
([#146](#146))
([7f2537b](7f2537b))
* optimise ux for slack component
([#143](#143))
([ed60235](ed60235))
* refactor package structure
([#140](#140))
([4853d4c](4853d4c))
* support markdown to text function in text operator
([#149](#149))
([dcbae37](dcbae37))
* unify component interface
([#144](#144))
([ad35e10](ad35e10))


### Bug Fixes

* bug of failure of document component
([#152](#152))
([aed51f8](aed51f8))

---
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

- In our new VDP recipe design, there is not much difference between
connectors and operators, and the term "connector" doesn't provide
useful information to the user. Therefore, we decided to flatten the
component structure. The original connectors will be directly
categorized into `ai`, `data`, and `application` components.

This commit

- Modifies the folder structure to categorize connectors into `ai`,
`data`, and `application` components.
- Removes `/pkg` folder.

Note

- In this PR, we only modify the folder structure. In the upcoming PRs,
we'll further refactor the component interface to unify the connector
and operator interfaces into one component interface.
namwoam pushed a commit to namwoam/component that referenced this pull request Jun 24, 2024
🤖 I have created a release *beep* *boop*
---


##
[0.19.0-beta](instill-ai/component@v0.18.0-beta...v0.19.0-beta)
(2024-06-05)


### Features

* add pdf component
([instill-ai#138](instill-ai#138))
([517afcf](instill-ai@517afcf))
* add task chunk text
([instill-ai#139](instill-ai#139))
([7b36553](instill-ai@7b36553))
* **instill:** adopt latest Model endpoints
([instill-ai#146](instill-ai#146))
([7f2537b](instill-ai@7f2537b))
* optimise ux for slack component
([instill-ai#143](instill-ai#143))
([ed60235](instill-ai@ed60235))
* refactor package structure
([instill-ai#140](instill-ai#140))
([4853d4c](instill-ai@4853d4c))
* support markdown to text function in text operator
([instill-ai#149](instill-ai#149))
([dcbae37](instill-ai@dcbae37))
* unify component interface
([instill-ai#144](instill-ai#144))
([ad35e10](instill-ai@ad35e10))


### Bug Fixes

* bug of failure of document component
([instill-ai#152](instill-ai#152))
([aed51f8](instill-ai@aed51f8))

---
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
Projects
Status: 👋 Done
3 participants