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

Add notebook options to configs proto #1685

Merged
merged 3 commits into from
Mar 11, 2024
Merged

Add notebook options to configs proto #1685

merged 3 commits into from
Mar 11, 2024

Conversation

Ekrekr
Copy link
Contributor

@Ekrekr Ekrekr commented Mar 11, 2024

No description provided.

@Ekrekr Ekrekr requested review from lewish and removed request for lewish March 11, 2024 11:28
@Ekrekr
Copy link
Contributor Author

Ekrekr commented Mar 11, 2024

Will add this to ProjectConfig in core.proto while I'm here

@@ -40,6 +40,16 @@ message WorkflowSettings {

// Optional. The prefix to append to all action names.
string name_prefix = 9;

// Optional. Options for Notebook actions.
NotebookOptions notebook_options = 10;
Copy link
Collaborator

Choose a reason for hiding this comment

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

IMO I think we should not nest this. We don't nest anything else in here, even though they logically group (e.g dataset, location). Makes the API cleaner, we don't have a clear plan for what else would go in here either.

defaultNotebookOutputBucket at top level seems fine to me

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Me and Ben were talking about this, we want to migrate to nest the BQ options too

image

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not against nesting, but I don't think we are ready to design it yet. Agree we should restructure all this, but we need to sit down and think more deeply about how we want to structure these protos long term. Small questions like are these "Notebook" settings or "Vertex" settings for example, or would other actions potentially use GCS buckets that we want to configure (external tables, for example).

Which is why I'd suggest we do the simplest thing for the time being - that doesn't stop us from doing this in a future version!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

If we're following the same pattern as before, Notebook is an abstracted action type that sits across APIs - Vertex settings would break this pattern.

I've updated this to be the flat field because I'm under time pressure to get this in, but when we inevitably make these fields nested, it will be a lot more work to migrate them than if we just do it now!

@Ekrekr
Copy link
Contributor Author

Ekrekr commented Mar 11, 2024

Will add this to ProjectConfig in core.proto while I'm here

Done.

@Ekrekr Ekrekr requested a review from lewish March 11, 2024 11:55
@Ekrekr Ekrekr merged commit 6b943be into main Mar 11, 2024
4 checks passed
@Ekrekr Ekrekr deleted the notebook-options-proto branch March 11, 2024 12:01
moker-spaghetti pushed a commit to moker-spaghetti/dataform that referenced this pull request May 26, 2024
…-proto

Add notebook options to configs proto
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants