Sort results of plan-preview #5540

kj455 · 2025-02-04T23:11:10Z

What this PR does:
Adds the sort-key-labels feature to pipectl plan-preview.

The order of plan-preview results:

Default: Sorted by PipedId and ApplicationName
If specified: Sorted by the given label keys

Why we need it:
A sorted output would improve readability and facilitate easier identification of the modifications being made.

Which issue(s) this PR fixes:

Fixes #5539

Does this PR introduce a user-facing change?:

How are users affected by this change:
Is this breaking change:
How to migrate (if breaking change):

pkg/app/server/grpcapi/api.go

t-kikuc

@kj455
Thank you so much!!
Please fix the lint error as follows.

I'm still checking the logic (basically, your code seems great)

pkg/app/piped/planpreview/builder_test.go

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

t-kikuc

Thank you so much, I'd like to propose moving the code for customizability.

pkg/app/piped/planpreview/builder.go

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

t-kikuc

Thank you so much!!! It will work well.

Please add some tests and check if they result as you expect 🙏

pkg/app/pipectl/cmd/planpreview/planpreview_test.go

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

kj455 · 2025-02-14T07:44:43Z

@t-kikuc
Thank you for your review!

I’ve added test cases based on your advice. 😍

14b52df

t-kikuc

Thank you so much!!!!

(I'm sorry for changing the way again and again 🙏 )

TODO:

update docs
add options in the GitHub action

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

kj455 · 2025-02-14T11:21:01Z

@t-kikuc
Thank you for your kind review!

I really appreciate your help in shaping the implementation policy for this PR.

update docs

I have updated the documentation:
025c5c7

add options in the GitHub action

I have submitted a PR for this!
pipe-cd/actions-plan-preview#19

docs/content/en/docs-dev/user-guide/plan-preview.md

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

t-kikuc

LGreatTM
Thank you so much

Warashi

LGTM! Thank you!

* Sort results of plan-preview Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * Ensure the order of list piped Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * fix: lint Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * fix: move sorting to pipectl Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * fix: add testcase Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * fix: dev docs Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * add docs Signed-off-by: kj455 <kaji.ibuki45@gmail.com> --------- Signed-off-by: kj455 <kaji.ibuki45@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com>

* Correct notification routing for `DEPLOYMENT_STARTED` (#5523) * Correct notification routing for `DEPLOYMENT_STARTED` Signed-off-by: Yuki Okushi <okushi@canary-inc.jp> * Harden test case Signed-off-by: Yuki Okushi <okushi@canary-inc.jp> --------- Signed-off-by: Yuki Okushi <okushi@canary-inc.jp> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> * Sort results of plan-preview (#5540) * Sort results of plan-preview Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * Ensure the order of list piped Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * fix: lint Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * fix: move sorting to pipectl Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * fix: add testcase Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * fix: dev docs Signed-off-by: kj455 <kaji.ibuki45@gmail.com> * add docs Signed-off-by: kj455 <kaji.ibuki45@gmail.com> --------- Signed-off-by: kj455 <kaji.ibuki45@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> * Enhanced EventWatcher logs (#5558) * Show push error log earlier than reporting Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * Use WarnLog in retry Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * clarify log messages Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * clarify log messages Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * add TestDoCalls for asserting counts Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * add eventIDs in log Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * enrich logs in updateValues Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * nits Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> * Revert "add TestDoCalls for asserting counts" This reverts commit de3f112. Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> --------- Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> * update RELEASE to v0.50.2 with doc update (#5571) Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> --------- Signed-off-by: Yuki Okushi <okushi@canary-inc.jp> Signed-off-by: pipecd-bot <pipecd.dev@gmail.com> Signed-off-by: kj455 <kaji.ibuki45@gmail.com> Signed-off-by: t-kikuc <tkikuchi07f@gmail.com> Co-authored-by: Yuki Okushi <okushi@canary-inc.jp> Co-authored-by: Ibuki Kaji <38521709+kj455@users.noreply.github.com> Co-authored-by: Tetsuya KIKUCHI <97105818+t-kikuc@users.noreply.github.com>

github-actions bot added the area/go label Feb 4, 2025

kj455 force-pushed the sort-planpreview-results branch from b999433 to 343a5e1 Compare February 4, 2025 23:14

kj455 commented Feb 8, 2025

View reviewed changes

pkg/app/server/grpcapi/api.go Outdated Show resolved Hide resolved

kj455 force-pushed the sort-planpreview-results branch from 4615cc4 to 910bf2f Compare February 8, 2025 09:06

kj455 marked this pull request as ready for review February 8, 2025 09:06

kj455 requested review from khanhtc1202, ffjlabo, t-kikuc and Warashi as code owners February 8, 2025 09:06

t-kikuc reviewed Feb 10, 2025

View reviewed changes

pkg/app/piped/planpreview/builder_test.go Outdated Show resolved Hide resolved

t-kikuc mentioned this pull request Feb 10, 2025

Default sorting of the plan-preview output #5539

Closed

kj455 added 3 commits February 10, 2025 18:24

Sort results of plan-preview

342a646

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

Ensure the order of list piped

74f5960

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

fix: lint

cd13d3b

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

kj455 force-pushed the sort-planpreview-results branch from 910bf2f to cd13d3b Compare February 10, 2025 09:25

kj455 requested a review from t-kikuc February 10, 2025 09:28

t-kikuc reviewed Feb 12, 2025

View reviewed changes

pkg/app/piped/planpreview/builder.go Outdated Show resolved Hide resolved

fix: move sorting to pipectl

bc83f74

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

kj455 force-pushed the sort-planpreview-results branch from 8d15fc2 to bc83f74 Compare February 13, 2025 21:28

kj455 requested a review from t-kikuc February 13, 2025 21:32

t-kikuc reviewed Feb 14, 2025

View reviewed changes

pkg/app/pipectl/cmd/planpreview/planpreview_test.go Show resolved Hide resolved

pkg/app/pipectl/cmd/planpreview/planpreview_test.go Show resolved Hide resolved

pkg/app/pipectl/cmd/planpreview/planpreview_test.go Outdated Show resolved Hide resolved

fix: add testcase

14b52df

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

kj455 force-pushed the sort-planpreview-results branch from 1bf47e1 to 14b52df Compare February 14, 2025 07:42

kj455 requested a review from t-kikuc February 14, 2025 07:44

t-kikuc previously approved these changes Feb 14, 2025

View reviewed changes

fix: dev docs

025c5c7

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

kj455 dismissed t-kikuc’s stale review via 025c5c7 February 14, 2025 10:56

kj455 mentioned this pull request Feb 14, 2025

Add sort-label-keys pipe-cd/actions-plan-preview#19

Merged

kj455 requested a review from t-kikuc February 14, 2025 11:21

t-kikuc reviewed Feb 14, 2025

View reviewed changes

docs/content/en/docs-dev/user-guide/plan-preview.md Show resolved Hide resolved

add docs

3349625

Signed-off-by: kj455 <kaji.ibuki45@gmail.com>

kj455 requested a review from t-kikuc February 14, 2025 11:41

t-kikuc approved these changes Feb 14, 2025

View reviewed changes

t-kikuc added cherry-pick v0.50.2 labels Feb 14, 2025

Warashi approved these changes Feb 16, 2025

View reviewed changes

Warashi merged commit a6511aa into pipe-cd:master Feb 16, 2025
15 checks passed

github-actions bot mentioned this pull request Feb 17, 2025

update RELEASE to v0.50.2 #5571

Merged

github-actions bot mentioned this pull request Feb 17, 2025

Cherry-pick #5523 #5540 #5558 #5572

Closed

github-actions bot mentioned this pull request Feb 17, 2025

Cherry-pick #5523 #5540 #5558 #5571 #5573

Merged

t-kikuc mentioned this pull request Feb 17, 2025

Update base image to v0.50.2 pipe-cd/actions-plan-preview#20

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sort results of plan-preview #5540

Sort results of plan-preview #5540

kj455 commented Feb 4, 2025 •

edited

Loading

t-kikuc left a comment

t-kikuc left a comment

t-kikuc left a comment

kj455 commented Feb 14, 2025

t-kikuc left a comment

kj455 commented Feb 14, 2025

t-kikuc left a comment

Warashi left a comment

Sort results of plan-preview #5540

Sort results of plan-preview #5540

Conversation

kj455 commented Feb 4, 2025 • edited Loading

t-kikuc left a comment

Choose a reason for hiding this comment

t-kikuc left a comment

Choose a reason for hiding this comment

t-kikuc left a comment

Choose a reason for hiding this comment

kj455 commented Feb 14, 2025

t-kikuc left a comment

Choose a reason for hiding this comment

kj455 commented Feb 14, 2025

t-kikuc left a comment

Choose a reason for hiding this comment

Warashi left a comment

Choose a reason for hiding this comment

kj455 commented Feb 4, 2025 •

edited

Loading