iframe-proxy

arunsathiya · 2023-09-20T03:06:43Z

Summary

This PR introduces a new clear flag for the item-edit command within project command, to clear a specific field's value. Fixes #7962

Thought process

As discussed on that issue, the clear flag maps to the clearprojectv2itemfieldvalue mutation to clear the field value.
The clear flag requires the project-id and field-id flags, in addition to the core requirement of id flag.
When one of these flags is used in conjunction with clear, the process errors out with an appropriate error message: text, date, single-select-option-id, number, iteration-id.
clear flag can be used in conjunction with json format output.

Screenshots

Here's a command that updates the date field value: project item-edit --id PVTI_lAHOARuJY84AVcnszgJPkl4 --project-id PVT_kwHOARuJY84AVcns --field-id PVTF_lAHOARuJY84AVcnszgN11mU --date 2023-09-22

To clear the date value: project item-edit --id PVTI_lAHOARuJY84AVcnszgJPkl4 --project-id PVT_kwHOARuJY84AVcns --field-id PVTF_lAHOARuJY84AVcnszgN11mU --clear

…alue

…ng, specify that it's necessary to update the field value

andyfeller

@arunsathiya : Thank you for your contribution! ✨

Reviewing your changes seem logically sound though I'd like to engage with @mntlty on some design thoughts to ensure the code base continues being manageable. Thank you for your patience 🙇

…to RunE

…o individual functions for better readability; refactor field ID and project ID presence check into a separate function

arunsathiya · 2023-09-29T19:20:36Z

andyfeller · 2023-10-02T12:55:22Z

@arunsathiya : Thank you for your patience 🙇 In kicking off the the testing workflows, it appears we have several tests failing here

Error: required flag(s) "id" not set
Usage:
  item-edit [flags]

Examples:
# edit an item's text field value
gh project item-edit --id <item-ID> --field-id <field-ID> --project-id <project-ID> --text "new text"

# clear an item's field value
gh project item-edit --id <item-ID> --field-id <field-ID> --project-id <project-ID> --clear


Flags:
      --body string                      Body of the draft issue item
      --clear                            Remove field value
      --date string                      Date value for the field (YYYY-MM-DD)
      --field-id string                  ID of the field to update
      --format string                    Output format: {json}
  -h, --help                             help for item-edit
      --id string                        ID of the item to edit
      --iteration-id string              ID of the iteration value to set on the field
      --number float32                   Number value for the field
      --project-id string                ID of the project to which the field belongs to
      --single-select-option-id string   ID of the single select option value to set on the field
      --text string                      Text value for the field
      --title string                     Title of the draft issue item

Error: only one of `--text`, `--number`, `--date`, `--single-select-option-id` or `--iteration-id` may be used
Usage:
  item-edit [flags]

Examples:
# edit an item's text field value
gh project item-edit --id <item-ID> --field-id <field-ID> --project-id <project-ID> --text "new text"

# clear an item's field value
gh project item-edit --id <item-ID> --field-id <field-ID> --project-id <project-ID> --clear


Flags:
      --body string                      Body of the draft issue item
      --clear                            Remove field value
      --date string                      Date value for the field (YYYY-MM-DD)
      --field-id string                  ID of the field to update
      --format string                    Output format: {json}
  -h, --help                             help for item-edit
      --id string                        ID of the item to edit
      --iteration-id string              ID of the iteration value to set on the field
      --number float32                   Number value for the field
      --project-id string                ID of the project to which the field belongs to
      --single-select-option-id string   ID of the single select option value to set on the field
      --text string                      Text value for the field
      --title string                     Title of the draft issue item

--- FAIL: TestRunItemEdit_Draft (0.00s)
    item_edit_test.go:196: 
        	Error Trace:	/home/runner/work/cli/cli/pkg/cmd/project/item-edit/item_edit_test.go:196
        	Error:      	Received unexpected error:
        	            	SilentError
        	Test:       	TestRunItemEdit_Draft
--- FAIL: TestRunItemEdit_Text (0.01s)
    item_edit_test.go:246: 
        	Error Trace:	/home/runner/work/cli/cli/pkg/cmd/project/item-edit/item_edit_test.go:246
        	Error:      	Received unexpected error:
        	            	SilentError
        	Test:       	TestRunItemEdit_Text
--- FAIL: TestRunItemEdit_Number (0.01s)
    item_edit_test.go:295: 
        	Error Trace:	/home/runner/work/cli/cli/pkg/cmd/project/item-edit/item_edit_test.go:295
        	Error:      	Received unexpected error:
        	            	SilentError
        	Test:       	TestRunItemEdit_Number
--- FAIL: TestRunItemEdit_Date (0.01s)
    item_edit_test.go:345: 
        	Error Trace:	/home/runner/work/cli/cli/pkg/cmd/project/item-edit/item_edit_test.go:345

Starting to look over the failures and what about the code changes that is a problem

andyfeller

@arunsathiya : I think these changes should allow the test to pass successfully

arunsathiya · 2023-10-02T18:46:01Z

@andyfeller Thank you for that pointer! My bad that I didn't run tests earlier, noted for the future! 🙇🏼

I couldn't apply your suggestions from GitHub UI because it does not allow applying suggestions on deleted lines, so I made the changes locally and tagged you as a co-author of the commit: c8b4652

Tests pass now.

andyfeller · 2023-10-03T12:33:37Z

andyfeller

LGTM! Let's get those tests green and get this merged

arunsathiya added 3 commits September 19, 2023 19:03

Introduce clear flag on 'project item-edit' command to remove field v…

55b41d8

…alue

Driveby unrelated update: when both field ID and project ID are missi…

dde84c2

…ng, specify that it's necessary to update the field value

Tests for the new clear flag

31fd8df

arunsathiya requested a review from a team as a code owner September 20, 2023 03:06

arunsathiya requested review from samcoe and removed request for a team September 20, 2023 03:06

cliAutomation added the external pull request originating outside of the CLI core team label Sep 20, 2023

Merge branch 'trunk' into new/7962-clear-flag-to-remove-field-value

cfe055c

andyfeller reviewed Sep 22, 2023

View reviewed changes

Comment thread pkg/cmd/project/item-edit/item_edit.go

Comment thread pkg/cmd/project/item-edit/item_edit.go Outdated

arunsathiya added 4 commits September 29, 2023 11:54

Move field value flag and clear flag exclusivity one level higher up …

6f6e179

…to RunE

Add clear flag usage example

9d81ca0

Document clear flag in long form help as well

eebef99

Split clearing item, updating draft item and updating item values int…

45e4bf7

…o individual functions for better readability; refactor field ID and project ID presence check into a separate function

andyfeller suggested changes Oct 2, 2023

View reviewed changes

Comment thread pkg/cmd/project/item-edit/item_edit.go

Comment thread pkg/cmd/project/item-edit/item_edit.go

Comment thread pkg/cmd/project/item-edit/item_edit.go Outdated

Bubble up return value from inner function calls in runEditItem

c8b4652

arunsathiya and others added 2 commits October 2, 2023 11:47

Merge branch 'trunk' into new/7962-clear-flag-to-remove-field-value

39466f3

Merge branch 'trunk' into new/7962-clear-flag-to-remove-field-value

d283e11

andyfeller approved these changes Oct 3, 2023

View reviewed changes

andyfeller merged commit b775a90 into cli:trunk Oct 3, 2023

arunsathiya deleted the new/7962-clear-flag-to-remove-field-value branch October 3, 2023 16:44

Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

update(project/item-edit): New clear flag to remove item field value#8024

update(project/item-edit): New clear flag to remove item field value#8024
andyfeller merged 11 commits into
cli:trunkfrom
arunsathiya:new/7962-clear-flag-to-remove-field-value

arunsathiya commented Sep 20, 2023

Uh oh!

andyfeller left a comment

Uh oh!

Uh oh!

Uh oh!

arunsathiya commented Sep 29, 2023

Uh oh!

andyfeller commented Oct 2, 2023

Uh oh!

andyfeller left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

arunsathiya commented Oct 2, 2023

Uh oh!

andyfeller commented Oct 3, 2023

Uh oh!

andyfeller left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

Conversation

arunsathiya commented Sep 20, 2023

Summary

Thought process

Screenshots

Uh oh!

andyfeller left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

arunsathiya commented Sep 29, 2023

Uh oh!

andyfeller commented Oct 2, 2023

Uh oh!

andyfeller left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

arunsathiya commented Oct 2, 2023

Uh oh!

andyfeller commented Oct 3, 2023

Uh oh!

andyfeller left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants