Skip to content
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

comment-report-format option allows to summarize report comment by each changed file #107

Merged
merged 1 commit into from
Mar 15, 2024

Conversation

krrrr38
Copy link
Contributor

@krrrr38 krrrr38 commented Mar 9, 2024

Motivation

When we have multiple file changes, sometimes we want to view only a specific changed file. Current comment format is difficult to find a specific changed file.

Solution

Add a comment-report-format: "summarized" config. It make add more <details> tag into each changed file.

Debug

just kick sample repository using forked github action.

with `comment-report-format: "summarized"` config

reports can be expanded by each file.

    - uses: krrrr38/reg-actions@comment-report-format-summarized-dist
      with:
        ...
        comment-report-format: "summarized"
image
without `comment-report-format` config

no changed behaviors.

    - uses: krrrr38/reg-actions@comment-report-format-summarized-dist
      with:
        ...
        # comment-report-format: "summarized"
image

@krrrr38 krrrr38 changed the title feat: comment-report-format option allow to summarize changed file comment format comment-report-format option allow to summarize by each changed file Mar 9, 2024
@krrrr38 krrrr38 changed the title comment-report-format option allow to summarize by each changed file comment-report-format option allows to summarize report comment by each changed file Mar 9, 2024
@bokuweb
Copy link
Member

bokuweb commented Mar 15, 2024

@krrrr38 Thanks for you PR. Looks good 👍

@bokuweb bokuweb merged commit 8d03dcc into reg-viz:main Mar 15, 2024
0 of 2 checks passed
@krrrr38 krrrr38 deleted the comment-report-format-summarized branch March 15, 2024 13:58
bokuweb added a commit that referenced this pull request Jul 17, 2024
* Update README.md

* fix: 103 (#104)

* fix: comment (#105)

Co-authored-by: bokuweb <bokuweb@bokuwebnoair.lan>

* feat: comment-report-format option allow to summarize changed file comment format (#107)

* fix: `The disable-branch option is not working` (#112)

* test

* test

* test

* test

* fix: input

* fix: report generation (#113)

* deps: update (#114)

* build(deps): bump follow-redirects from 1.15.2 to 1.15.4 (#106)

Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.2 to 1.15.4.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](follow-redirects/follow-redirects@v1.15.2...v1.15.4)

---
updated-dependencies:
- dependency-name: follow-redirects
  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: bokuweb <bokuweb12@gmail.com>

* Delete yarn.lock

* build(deps): bump undici from 5.28.3 to 5.28.4 (#120)

Bumps [undici](https://github.com/nodejs/undici) from 5.28.3 to 5.28.4.
- [Release notes](https://github.com/nodejs/undici/releases)
- [Commits](nodejs/undici@v5.28.3...v5.28.4)

---
updated-dependencies:
- dependency-name: undici
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fix: 118 (#121)

* fix: #118 (#122)

* feat: add cleanup workspace directory (#124)

* handle: error (#125)

* fix: handle comment size limitation (#126)

* Update comment.ts (#128)

* chore: add logs (#129)

* chore: add logs (#130)

* fix

* fix

* chore: update deps (#131)

* feat: add link for artifact (#133)

* deps: update deps (#132)

* fix: use artifact client for download (#135)

* fix: use artifact client for download

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* fix

* Revert "fix: use artifact client for download (#135)" (#136)

This reverts commit 19d3918.

* feat: outdated comment action option to minimize previous reg-action comments (#138)

* feat: Support retention days (#139)

* feat: Support retention days

* test

* test

* test

* remove test

* green keep (#140)

* fix retention-days input parameter (#141)

* chore: add log (#142)

* fix: use for (#143)

* fix (#144)

* fix: replace client (#145)

* Revert "fix: replace client (#145)" (#146)

This reverts commit 60a8105.

* fix: threshold-pixel param default overrides threshold-rate (#147)

Allows threshold-pixel value to be null as well, if not defined.
That way, when specifying threshold-rate, only the threshold-rate will
be applied. Otherwise threshold-rate does not have any effect, since
it will always be overriden by threshold-pixel that defaults to 0.

* feat: allow specifying expected images directory

This way, it is not needed to find previous runs and download an artifact.
Instead, the images are copied from the expected images directory
and compared immediately.

* add missing property into action.yml

* revert back to using targetRun parameter

* fix validation of expectedImagesDirectoryPath

* do not allow empty expectedImagesDirectoryPath if it's defined

* Remove `allowEmpty` from `validateImageDirPath`

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: bokuweb <bokuweb12@gmail.com>
Co-authored-by: bokuweb <bokuweb@bokuwebnoair.lan>
Co-authored-by: Ken Kaizu <k.kaizu38@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Yuki Mima <amyu@r.recruit.co.jp>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants