Skip to content

Add 'title' to distinguish multiple projects in actions-plan-preview #5905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jun 2, 2025

Conversation

t-kikuc
Copy link
Member

@t-kikuc t-kikuc commented May 30, 2025

What this PR does:

  • Added title input
  • Show title in result header
  • Avoid minimizing the result with the same title

After this PR is merged, I will update pipe-cd/actions-plan-preview#21 and we'll release.

Example
planpreview-

planpreview config:

jobs:
  plan-preview-alice:
    steps:
      - with:
          api-key: ${{ secrets.PIPECD_PLAN_PREVIEW_API_KEY }} // Project Alice
          title: "Alice Project" // HERE
          ....

  plan-preview-bob:
    steps:
      - with:
          api-key: ${{ secrets.PIPECD_PLAN_PREVIEW_API_KEY }} // Project Bob
          title: "Bob Project" // HERE
          ...

Why we need it:

as described in #5899

Which issue(s) this PR fixes:

Fixes #5899

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):

t-kikuc added 5 commits May 29, 2025 20:30
Signed-off-by: t-kikuc <[email protected]>
Signed-off-by: t-kikuc <[email protected]>
Signed-off-by: t-kikuc <[email protected]>
@t-kikuc t-kikuc requested a review from a team as a code owner May 30, 2025 11:53
@t-kikuc t-kikuc changed the title Planpreview/distinguish b args Add 'title' to distinguish multiple projects in actions-plan-preview May 30, 2025
Copy link

codecov bot commented May 30, 2025

Codecov Report

Attention: Patch coverage is 33.33333% with 16 lines in your changes missing coverage. Please review.

Project coverage is 27.90%. Comparing base (9be5674) to head (9bb4a1f).
Report is 4 commits behind head on master.

Files with missing lines Patch % Lines
tool/actions-plan-preview/planpreview.go 0.00% 8 Missing ⚠️
tool/actions-plan-preview/main.go 0.00% 6 Missing ⚠️
tool/actions-plan-preview/github.go 80.00% 2 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5905   +/-   ##
=======================================
  Coverage   27.89%   27.90%           
=======================================
  Files         519      519           
  Lines       55923    55936   +13     
=======================================
+ Hits        15600    15609    +9     
- Misses      39125    39129    +4     
  Partials     1198     1198           
Flag Coverage Δ
. 23.73% <ø> (-0.02%) ⬇️
.-pkg-app-pipedv1-plugin-example 0.00% <ø> (ø)
.-pkg-app-pipedv1-plugin-kubernetes 63.32% <ø> (ø)
.-pkg-app-pipedv1-plugin-kubernetes_multicluster 64.93% <ø> (ø)
.-pkg-app-pipedv1-plugin-wait 35.51% <ø> (ø)
.-pkg-plugin-sdk 49.25% <ø> (ø)
.-tool-actions-gh-release 19.23% <ø> (ø)
.-tool-actions-plan-preview 25.30% <33.33%> (+2.47%) ⬆️
.-tool-codegen-protoc-gen-auth 0.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

got, err := parseGitHubEvent(context.Background(), tc.prService, tc.eventName, tc.payload, tc.argPRNum)
assert.Equal(t, tc.expected, got)
assert.Equal(t, tc.expectedErr, err)
})
}
}

func TestFilterLatestPlanPreviewComment(t *testing.T) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[IMO] I think it's better to add a test case for a multibyte string.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!
I added: 9bb4a1f

Signed-off-by: t-kikuc <[email protected]>
Copy link
Member

@ffjlabo ffjlabo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@t-kikuc t-kikuc added the v0.52.1 label Jun 2, 2025
@t-kikuc t-kikuc enabled auto-merge (squash) June 2, 2025 06:06
Copy link
Member

@Warashi Warashi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@t-kikuc t-kikuc merged commit cf0fe25 into master Jun 2, 2025
47 checks passed
@t-kikuc t-kikuc deleted the planpreview/distinguish-B_args branch June 2, 2025 06:27
@github-actions github-actions bot mentioned this pull request Jun 2, 2025
github-actions bot pushed a commit that referenced this pull request Jun 2, 2025
…5905)

* add title to args

Signed-off-by: t-kikuc <[email protected]>

* Add the title to filter latest comments

Signed-off-by: t-kikuc <[email protected]>

* Use hash

Signed-off-by: t-kikuc <[email protected]>

* Fix tests

Signed-off-by: t-kikuc <[email protected]>

* add multibyte test

Signed-off-by: t-kikuc <[email protected]>

---------

Signed-off-by: t-kikuc <[email protected]>
Signed-off-by: pipecd-bot <[email protected]>
Warashi added a commit that referenced this pull request Jun 2, 2025
* Fix lint errors (#5897)

* Fix import grouping by make lint/go FIX=true

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>

* Fix linter errors by make lint/go FIX=true

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>

* Rewrite long if-else to switch

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>

* Remove unnecessary zero-value initialization

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>

* Remove unnecessary string conversion

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>

* Fix to correctly call deferred functions

log.Fatalf calls os.Exit(1) and deferred functions are not called.
This commit changes the _main function to return an integer and
call os.Exit from main.

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>

* Fix lint errors

log.Fatal calls os.Exit, so the deferred functions are not called.
This commit changes the _main function to return an integer and
call os.Exit from main.
This is a workaround to fix the lint errors.

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>

* Fix lint errors

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>

* Initialize the slice with the correct capacity

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>

* Change return type of doComment to int

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>

---------

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>
Signed-off-by: pipecd-bot <[email protected]>

* Add 'title' to distinguish multiple projects in actions-plan-preview (#5905)

* add title to args

Signed-off-by: t-kikuc <[email protected]>

* Add the title to filter latest comments

Signed-off-by: t-kikuc <[email protected]>

* Use hash

Signed-off-by: t-kikuc <[email protected]>

* Fix tests

Signed-off-by: t-kikuc <[email protected]>

* add multibyte test

Signed-off-by: t-kikuc <[email protected]>

---------

Signed-off-by: t-kikuc <[email protected]>
Signed-off-by: pipecd-bot <[email protected]>

* Revert "Do treeless clone for git clone to improve performance (#5722)" (#5908)

This reverts commit 7e74937.

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>
Signed-off-by: pipecd-bot <[email protected]>

* Cut release v0.52.1 (#5909)

Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Warashi <[email protected]>
Signed-off-by: pipecd-bot <[email protected]>

---------

Signed-off-by: Shinnosuke Sawada-Dazai <[email protected]>
Signed-off-by: pipecd-bot <[email protected]>
Signed-off-by: t-kikuc <[email protected]>
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Shinnosuke Sawada-Dazai <[email protected]>
Co-authored-by: Tetsuya KIKUCHI <[email protected]>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Warashi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Enhance the result of PlanPreview Action to distinguish multiple projects
4 participants