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: add support for seedProjects with descriptions via seedProjectsWithDetails #5864

Conversation

Terryhung
Copy link
Contributor

@Terryhung Terryhung commented Oct 18, 2024

Tracking issue

Closes #3742

Why are the changes needed?

The changes introduce the ability to specify both a name and a description for seed projects using seedProjectsWithDetails. This enhancement improves flexibility by allowing users to provide additional context when defining seed projects, making managing and tracking seed projects in Flyte easier.

What changes were proposed in this pull request?

This pull request adds support for defining seed projects with descriptions through a new field, seedProjectsWithDetails.

  • Introduces seedProjectsWithDetails, allowing users to provide both a name and a description for each seed project.
  • Ensures that if a project exists in both seedProjects and seedProjectsWithDetails, the description from seedProjectsWithDetails will take precedence.
  • Automatically generates a default description for projects defined only in seedProjects without a corresponding description.

How was this patch tested?

Unit tested.

Setup process

Screenshots

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Related PRs

Docs link

@Terryhung Terryhung changed the title [WIP] feat: add support for seedProjects with descriptions via seedProjects… [WIP] feat: add support for seedProjects with descriptions Oct 18, 2024
@Terryhung Terryhung changed the title [WIP] feat: add support for seedProjects with descriptions feat: add support for seedProjects with descriptions via seedProjectsWithDetails Oct 18, 2024
@Terryhung Terryhung marked this pull request as ready for review October 18, 2024 19:14
Copy link

codecov bot commented Oct 18, 2024

Codecov Report

Attention: Patch coverage is 91.66667% with 3 lines in your changes missing coverage. Please review.

Project coverage is 36.84%. Comparing base (7f92953) to head (fedad63).
Report is 1 commits behind head on master.

Files with missing lines Patch % Lines
flyteadmin/cmd/entrypoints/migrate.go 0.00% 2 Missing ⚠️
flyteadmin/pkg/server/initialize.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #5864      +/-   ##
==========================================
+ Coverage   36.82%   36.84%   +0.02%     
==========================================
  Files        1309     1309              
  Lines      130938   130967      +29     
==========================================
+ Hits        48220    48258      +38     
+ Misses      78534    78525       -9     
  Partials     4184     4184              
Flag Coverage Δ
unittests-datacatalog 51.58% <ø> (ø)
unittests-flyteadmin 54.14% <91.66%> (+0.11%) ⬆️
unittests-flytecopilot 11.73% <ø> (ø)
unittests-flytectl 62.40% <ø> (-0.05%) ⬇️
unittests-flyteidl 6.92% <ø> (ø)
unittests-flyteplugins 53.64% <ø> (ø)
unittests-flytepropeller 43.00% <ø> (ø)
unittests-flytestdlib 55.39% <ø> (ø)

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.

@Terryhung Terryhung force-pushed the terryhung/add-the-new-type-of-admin-seed-porjects-in-config branch from 47bef33 to ed79c68 Compare October 23, 2024 12:13
@Terryhung Terryhung force-pushed the terryhung/add-the-new-type-of-admin-seed-porjects-in-config branch from ed79c68 to ea2e834 Compare October 23, 2024 13:27
@Future-Outlier Future-Outlier enabled auto-merge (squash) October 25, 2024 04:09
Copy link
Member

@troychiu troychiu left a comment

Choose a reason for hiding this comment

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

Could you add examples of how to use the feature you add? Thank you!

@Future-Outlier Future-Outlier merged commit 1279740 into flyteorg:master Oct 25, 2024
56 checks passed
Copy link

welcome bot commented Oct 25, 2024

Congrats on merging your first pull request! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[FlyteCTL Feature] Allow seed project description to be set
5 participants