Handle plan preview workflow's error and exit with error status code #4662

TakumaKurosawa · 2023-11-08T09:47:58Z

What this PR does / why we need it:
Plan preview workflow comments error message but CI workflow passed.
It makes us very confused.

Which issue(s) this PR fixes:

Fixes #4661

Does this PR introduce a user-facing change?:

How are users affected by this change:
- Plan preview CI workflow will failed when result has error
Is this breaking change:
How to migrate (if breaking change):

codecov · 2023-11-08T11:57:00Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (88d7fb6) 30.83% compared to head (23a79cd) 30.84%.
Report is 2 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #4662   +/-   ##
=======================================
  Coverage   30.83%   30.84%           
=======================================
  Files         221      221           
  Lines       25941    25935    -6     
=======================================
  Hits         7999     7999           
+ Misses      17292    17286    -6     
  Partials      650      650

see 7 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

khanhtc1202 · 2023-11-09T15:26:53Z

tool/actions-plan-preview/main.go

@@ -139,6 +139,9 @@ func main() {
 			doComment(failureBadgeURL + "\nUnable to run plan-preview for a closed pull request.")
 			return
 		}
+		body := makeCommentBody(event, result)
+		doComment(failureBadgeURL + body)


Should we add linebreak \n in between? 🤔

Exactly 👍
I applied!!
b00eec6

Signed-off-by: Takumaron <tennis.takumax@gmail.com>

kurochan · 2023-11-10T01:26:07Z

tool/actions-plan-preview/main.go

@@ -139,6 +139,9 @@ func main() {
 			doComment(failureBadgeURL + "\nUnable to run plan-preview for a closed pull request.")
 			return
 		}
+		body := makeCommentBody(event, result)
+		doComment(failureBadgeURL + "\n" + body)
+		log.Fatal("plan-preview result has error")


This case is an expected error. Therefore, it is inappropriate to set the log level to fatal.
If you just want to call exit(1), I think you can simply call exit(1).

@kurochan
You mean fatal log level must be used when unexpected error, right?
I agree with your point 👍
I'll fix later, thanks.

@kurochan
Applied!!
23a79cd

Signed-off-by: Takumaron <tennis.takumax@gmail.com>

khanhtc1202

Here you go 🚀

…4662)

#4628 #4629 #4631 #4632 #4633 #4637 #4638 #4641 #4648 #4650 #4656 #4658 #4662 #4666 (#4669) * Bump golang.org/x/net from 0.7.0 to 0.17.0 in /tool/actions-plan-preview (#4611) Bumps [golang.org/x/net](https://github.com/golang/net) from 0.7.0 to 0.17.0. - [Commits](golang/net@v0.7.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump golang.org/x/net from 0.7.0 to 0.17.0 in /tool/actions-gh-release (#4612) Bumps [golang.org/x/net](https://github.com/golang/net) from 0.7.0 to 0.17.0. - [Commits](golang/net@v0.7.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Khanh Tran <32532742+khanhtc1202@users.noreply.github.com> * Bump golang.org/x/net from 0.8.0 to 0.17.0 (#4613) Bumps [golang.org/x/net](https://github.com/golang/net) from 0.8.0 to 0.17.0. - [Commits](golang/net@v0.8.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump @babel/traverse from 7.14.7 to 7.23.2 in /web (#4619) * Fix part of lint/go errors (misspell, depguard, unconvert) (#4621) * Fix lint/go errors (misspell) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Fix lint/go errors (depguard) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Fix lint/go errors (unconvert) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> --------- Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Fix part of lint/go errors (goimports, staticcheck, gosimple) (#4622) * Fix lint/go errors (goimport) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Fix lint/go errors (staticcheck) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Fix lint/go errors (gosimple) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Fix lint/go errors (gosimple) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Fix return error by function Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> --------- Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Fix part of lint/go errors (deadcode, ineffassign, depguard) (#4624) * Ignore mannwhitney from golangci-lint Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Fix lint/go errors (deadcode) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Fix lint/go errors (depguard) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> --------- Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Add tests to terraform platform provider (#4625) Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> * Add tests to apikey model (#4626) Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> * Add tests to application model (#4627) Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> * Reduce `make lint/go` execution time by adding the GOCACHE environment variable (#4628) * Add GOCACHE env to lint/go Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Add verbose flag to lint/go Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Change timeout golangci.yml Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> --------- Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Add tests to model/deployment (#4629) Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> * Add tests to model/notificationevent (#4631) * Add tests to model/notificationevent Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> * Add Parallel() Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> --------- Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> * Add tests to model/deployment_chain (#4632) * Bump google.golang.org/grpc from 1.54.0 to 1.56.3 (#4633) * Bump google.golang.org/grpc from 1.54.0 to 1.56.3 Bumps [google.golang.org/grpc](https://github.com/grpc/grpc-go) from 1.54.0 to 1.56.3. - [Release notes](https://github.com/grpc/grpc-go/releases) - [Commits](grpc/grpc-go@v1.54.0...v1.56.3) --- updated-dependencies: - dependency-name: google.golang.org/grpc dependency-type: direct:production ... Signed-off-by: dependabot[bot] <support@github.com> * Update grpc test version Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: khanhtc1202 <khanhtc1202@gmail.com> * Fix lint/go errors (gocritic) (#4637) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Fix part of lint/go errors (stylecheck) (#4638) * Fix lint/go errors (stylecheck) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Remove nolint:stylecheck Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Change method reveiver name Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Change receiver name k to ak Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> --------- Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Bump github.com/docker/docker (#4641) * Make actions plan preview handle timeout option (#4648) * Format and make tests pass in tool/actions-plan-preview Signed-off-by: mi11km <mi11km.program@gmail.com> * Use --piped-handle-timeout to make the timeout arg activate Signed-off-by: mi11km <mi11km.program@gmail.com> * Add tests to model/notificationevent (#4631) * Add tests to model/notificationevent Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> * Add Parallel() Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> --------- Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> Signed-off-by: mi11km <mi11km.program@gmail.com> * add piped-handle-timeout(input args) Signed-off-by: mi11km <mi11km.program@gmail.com> --------- Signed-off-by: mi11km <mi11km.program@gmail.com> Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> Co-authored-by: Kenta Kozuka <kenta.kozuka@gmail.com> Co-authored-by: Khanh Tran <32532742+khanhtc1202@users.noreply.github.com> * Fix panic error in ListDeployments API (#4650) * Update golangci-lint and fix lint errors (#4656) Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> * Send error comment before plan preview exit (#4658) * Send error comment before plan preview exit Signed-off-by: Takumaron <tennis.takumax@gmail.com> * Apply review commnet Signed-off-by: Takumaron <tennis.takumax@gmail.com> --------- Signed-off-by: Takumaron <tennis.takumax@gmail.com> * Handle plan preview workflow's error and exit with error status code (#4662) * Add a flag to skip running standalone task during deployment (#4666) * Add a flag to skip running standalone task during deployment Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> * Fix docs Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> --------- Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: karamaru-alpha <mrnk3078@gmail.com> Signed-off-by: Kenta Kozuka <kenta.kozuka@gmail.com> Signed-off-by: khanhtc1202 <khanhtc1202@gmail.com> Signed-off-by: mi11km <mi11km.program@gmail.com> Signed-off-by: Takumaron <tennis.takumax@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Khanh Tran <32532742+khanhtc1202@users.noreply.github.com> Co-authored-by: karamaru <38310693+karamaru-alpha@users.noreply.github.com> Co-authored-by: Kenta Kozuka <kenta.kozuka@gmail.com> Co-authored-by: khanhtc1202 <khanhtc1202@gmail.com> Co-authored-by: Masafumi Ikeyama <54844746+mi11km@users.noreply.github.com> Co-authored-by: Seitaro Fujigaki <51070449+seitarof@users.noreply.github.com> Co-authored-by: Kurosawa Takuma <tennis.takumax@gmail.com>

…ipe-cd#4662)

…ipe-cd#4662) Signed-off-by: sZma5a <masaaki.haribote@gmail.com>

…ipe-cd#4662) Signed-off-by: 鈴木優耀 <suzuki_masaaki@cyberagent.co.jp>

TakumaKurosawa requested review from nghialv, khanhtc1202, kentakozuka and ffjlabo as code owners November 8, 2023 09:47

github-actions bot added the area/tool label Nov 8, 2023

TakumaKurosawa mentioned this pull request Nov 8, 2023

Must handle plan preview workflow's error and exit with error status code #4661

Closed

khanhtc1202 reviewed Nov 9, 2023

View reviewed changes

Handle plan preview workflow's error and exit with error status code

f068af8

Signed-off-by: Takumaron <tennis.takumax@gmail.com>

TakumaKurosawa force-pushed the handle-plan-preview-failed-case branch from 9e8cdf3 to f068af8 Compare November 10, 2023 01:21

TakumaKurosawa requested a review from khanhtc1202 November 10, 2023 01:23

kurochan reviewed Nov 10, 2023

View reviewed changes

Add line break

b00eec6

Signed-off-by: Takumaron <tennis.takumax@gmail.com>

TakumaKurosawa force-pushed the handle-plan-preview-failed-case branch from 7343e29 to b00eec6 Compare November 10, 2023 01:32

Use os.Exit(1) explicitly

23a79cd

Signed-off-by: Takumaron <tennis.takumax@gmail.com>

TakumaKurosawa requested a review from kurochan November 10, 2023 03:55

khanhtc1202 approved these changes Nov 11, 2023

View reviewed changes

khanhtc1202 merged commit ed86af9 into pipe-cd:master Nov 11, 2023
15 checks passed

TakumaKurosawa deleted the handle-plan-preview-failed-case branch November 13, 2023 00:45

TakumaKurosawa mentioned this pull request Nov 13, 2023

Update base image by commit hash pipe-cd/actions-plan-preview#14

Closed

ffjlabo mentioned this pull request Nov 13, 2023

Cherry-pick #4611 #4612 #4613 #4619 #4621 #4622 #4624 #4625 #4626 #4627 #4628 #4629 #4631 #4632 #4633 #4637 #4638 #4641 #4648 #4650 #4656 #4658 #4662 #4666 #4669

Merged

ffjlabo pushed a commit that referenced this pull request Nov 13, 2023

Handle plan preview workflow's error and exit with error status code (#…

2eed512

…4662)

github-actions bot mentioned this pull request Dec 1, 2023

Release v0.45.4 #4697

Merged

sZma5a pushed a commit to sZma5a/pipecd that referenced this pull request Dec 17, 2023

Handle plan preview workflow's error and exit with error status code (p…

d53662b

…ipe-cd#4662)

sZma5a pushed a commit to sZma5a/pipecd that referenced this pull request Dec 17, 2023

Handle plan preview workflow's error and exit with error status code (p…

628aecd

…ipe-cd#4662)

sZma5a pushed a commit to sZma5a/pipecd that referenced this pull request Dec 17, 2023

Handle plan preview workflow's error and exit with error status code (p…

72bffad

…ipe-cd#4662) Signed-off-by: sZma5a <masaaki.haribote@gmail.com>

github-actions bot mentioned this pull request Feb 6, 2024

Release v0.46.0 #4775

Merged

sZma5a pushed a commit to sZma5a/pipecd that referenced this pull request Feb 12, 2024

Handle plan preview workflow's error and exit with error status code (p…

3eb1d79

…ipe-cd#4662) Signed-off-by: 鈴木優耀 <suzuki_masaaki@cyberagent.co.jp>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Handle plan preview workflow's error and exit with error status code #4662

Handle plan preview workflow's error and exit with error status code #4662

TakumaKurosawa commented Nov 8, 2023

codecov bot commented Nov 8, 2023 •

edited

Loading

khanhtc1202 Nov 9, 2023

TakumaKurosawa Nov 10, 2023 •

edited

Loading

kurochan Nov 10, 2023

TakumaKurosawa Nov 10, 2023

TakumaKurosawa Nov 10, 2023

khanhtc1202 left a comment

Handle plan preview workflow's error and exit with error status code #4662

Handle plan preview workflow's error and exit with error status code #4662

Conversation

TakumaKurosawa commented Nov 8, 2023

codecov bot commented Nov 8, 2023 • edited Loading

Codecov Report

khanhtc1202 Nov 9, 2023

Choose a reason for hiding this comment

TakumaKurosawa Nov 10, 2023 • edited Loading

Choose a reason for hiding this comment

kurochan Nov 10, 2023

Choose a reason for hiding this comment

TakumaKurosawa Nov 10, 2023

Choose a reason for hiding this comment

TakumaKurosawa Nov 10, 2023

Choose a reason for hiding this comment

khanhtc1202 left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 8, 2023 •

edited

Loading

TakumaKurosawa Nov 10, 2023 •

edited

Loading