[SPARK-57862][INFRA] Allow create_spark_jira.py to set the issue description#56938
Closed
MaxGekk wants to merge 1 commit into
Closed
[SPARK-57862][INFRA] Allow create_spark_jira.py to set the issue description#56938MaxGekk wants to merge 1 commit into
MaxGekk wants to merge 1 commit into
Conversation
…ription ### What changes were proposed in this pull request? This PR extends `dev/create_spark_jira.py` (and its helper `dev/spark_jira_utils.py`) so the JIRA description can be set at creation time: - Add `-d`/`--description` and `--description-file` options (mutually exclusive) to `create_spark_jira.py`. - Add a `description` parameter to `create_jira_issue` and use it in the issue payload (previously hardcoded to an empty string). Backward compatible: without the new flags the behavior is unchanged. ### Why are the changes needed? `create_jira_issue` hardcoded `"description": ""`, so tickets created via the script had no body and the description had to be added manually afterwards. When creating many issues at once (e.g. a batch of sub-tasks under an umbrella), populating the description at creation time is much more efficient. ### Does this PR introduce _any_ user-facing change? No. This is a developer tooling change; without the new flags the behavior is unchanged. ### How was this patch tested? Manually created JIRA sub-tasks with `--description-file` and verified the description on the resulting issues. ### Was this patch authored or co-authored using generative AI tooling? Generated-by: Cursor
sarutak
approved these changes
Jul 2, 2026
sarutak
reviewed
Jul 2, 2026
| if not args.parent and not args.type: | ||
| parser.error("-t/--type is required when not creating a subtask") | ||
|
|
||
| if args.description and args.description_file: |
Member
There was a problem hiding this comment.
args.description will be falsy if the user passes -d "", so the mutual-exclusion check would be bypassed in that edge case. is not None would be stricter. Not a blocker though as the rest of this file uses the same truthy-check style (e.g. if args.parent and args.type:).
Member
Author
There was a problem hiding this comment.
Thanks for the review and the approval! Good point on the -d "" edge case. I kept the truthy check for consistency with the rest of the file (e.g. if args.parent and args.type:), but happy to switch to is not None if you'd prefer. Thanks again!
Member
There was a problem hiding this comment.
Yeah, I think it's OK to keep the truthy check in this PR.
Member
Author
|
Merging to master/4.x. Thank you, @sarutak for review. |
MaxGekk
added a commit
that referenced
this pull request
Jul 2, 2026
…ription ### What changes were proposed in this pull request? This PR extends `dev/create_spark_jira.py` (and its helper `dev/spark_jira_utils.py`) so the JIRA description can be set at creation time: - Add `-d`/`--description` and `--description-file` options (mutually exclusive) to `create_spark_jira.py`. - Add a `description` parameter to `create_jira_issue` and use it in the issue payload (previously hardcoded to an empty string). Backward compatible: without the new flags the behavior is unchanged. ### Why are the changes needed? `create_jira_issue` hardcoded `"description": ""`, so **tickets created via the script had no body** and the description had to be added manually afterwards. When creating many issues at once (e.g. a batch of sub-tasks under an umbrella), populating the description at creation time is much more efficient. ### Does this PR introduce _any_ user-facing change? No. This is a developer tooling change; without the new flags the behavior is unchanged. ### How was this patch tested? Manually created JIRA sub-tasks with `--description-file` and verified the description on the resulting issues. ### Was this patch authored or co-authored using generative AI tooling? Generated-by: Cursor Closes #56938 from MaxGekk/SPARK-57862. Authored-by: Maxim Gekk <max.gekk@gmail.com> Signed-off-by: Max Gekk <max.gekk@gmail.com> (cherry picked from commit d20a8ec) Signed-off-by: Max Gekk <max.gekk@gmail.com>
Member
Author
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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?
This PR extends
dev/create_spark_jira.py(and its helperdev/spark_jira_utils.py) so the JIRA description can be set at creation time:-d/--descriptionand--description-fileoptions (mutually exclusive) tocreate_spark_jira.py.descriptionparameter tocreate_jira_issueand use it in the issue payload (previously hardcoded to an empty string).Backward compatible: without the new flags the behavior is unchanged.
Why are the changes needed?
create_jira_issuehardcoded"description": "", so tickets created via the script had no body and the description had to be added manually afterwards. When creating many issues at once (e.g. a batch of sub-tasks under an umbrella), populating the description at creation time is much more efficient.Does this PR introduce any user-facing change?
No. This is a developer tooling change; without the new flags the behavior is unchanged.
How was this patch tested?
Manually created JIRA sub-tasks with
--description-fileand verified the description on the resulting issues.Was this patch authored or co-authored using generative AI tooling?
Generated-by: Cursor