[SPARK-52663][SDP] Introduce name field to pipeline spec #51353
Closed
Conversation
This file contains hidden or 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
HyukjinKwon
approved these changes
Jul 3, 2025
|
@sryza shall we update the programming guide as well? |
dongjoon-hyun
approved these changes
Jul 5, 2025
|
👍 thanks for the review @HyukjinKwon @gengliangwang and @dongjoon-hyun – I updated the programming guide to include the name property in the pipeline spec example, and I also filed a JIRA to track adding explanations of each of the properties: https://issues.apache.org/jira/browse/SPARK-52690. |
sryza
commented
Jul 5, 2025
| @@ -99,7 +100,7 @@ The `spark-pipelines` command line interface (CLI) is the primary way to execute | |||
|
|
|||
| ### `spark-pipelines init` | |||
|
|
|||
| `spark-pipelines init` generates a simple pipeline project, including a spec file and example definitions. | |||
| `spark-pipelines init --name my_pipeline` generates a simple pipeline project, inside a directory named "my_pipeline", including a spec file and example definitions. | |||
There was a problem hiding this comment.
Note that the --name option was already required here, but wasn't documented as such.
gengliangwang
approved these changes
Jul 5, 2025
|
Thanks, merging to master! |
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.
What changes were proposed in this pull request?
The Declarative Pipelines SPIP included a "name" field in the pipeline spec, but we left that out in the earlier implementation. This adds it in.
The name field is required. This matches behavior for similar systems, like dbt.
Why are the changes needed?
See above.
Does this PR introduce any user-facing change?
Yes, but only to unreleased code.
How was this patch tested?
Updated existing tests, and added tests for proper error when the name is missing.
Was this patch authored or co-authored using generative AI tooling?