Reformat action thread comments #24

shenxianpeng · 2022-11-18T08:01:16Z

The thread comments not looks fancy than other projects:

codecov Skip file when no new lines added and lines-changed-only is asserted #21 (comment)
sonarcloud Skip file when no new lines added and lines-changed-only is asserted #21 (comment)
dependabot chore(deps): bump hexo-generator-tag from 1.0.0 to 2.0.0 shenxianpeng/blog#59 (comment)

Maybe we could reformat thread comments, I draft a new one (WIP), and I will continue to update if there is a new idea.

Cpp-Linter Report ⚠️

Some files didn't pass the configured checks.

Check the details

The following files need to be formatted (report from clang-format)

demo.hpp
demo.cpp

The following files have static analysis errors (report from clang-tidy)

demo.hpp

demo.hpp:10:11: warning: [modernize-use-trailing-return-type]

use a trailing return type for this function

    void *not_usefull(char *str){
    ~~~~~~^
    auto                         -> void *

demo.hpp:12:16: warning: [modernize-use-nullptr]

use nullptr

        return 0;
               ^
               nullptr

demo.cpp

demo.cpp:5:5: warning: [modernize-use-trailing-return-type]

use a trailing return type for this function

int main()
~~~ ^
auto       -> int

demo.cpp:7:13: warning: [readability-braces-around-statements]

statement should be inside braces

    for (;;)
            ^
             {

demo.cpp:11:5: warning: [cppcoreguidelines-pro-type-vararg]

do not call c-style vararg functions

    printf("Hello world!\n");
    ^

Have any feedback or feature suggestions? Share it here.

Cpp-Linter Report ✔️

No problems need attention.

Have any feedback or feature suggestions? Share it here.

2bndy5 · 2022-11-18T08:47:05Z

I have no objections to this.

2bndy5 · 2022-11-26T19:41:55Z

If this is to be shown after successful runs, then I think it would be good to be more concise.

Cpp-Linter Report ✔️

No problems need attention.

Have any feedback or feature suggestions? Share it here.

shenxianpeng · 2022-11-30T07:06:34Z

If there are many files that were changed, the old thread comments are too long, see https://github.com/Bliztle/p1-bargain/pull/16

2bndy5 · 2022-11-30T07:24:06Z

Instead of showing the errors, we could show a simple table that summarizes the results.

file	clang-tidy	clang-format
demo/demo.cpp	🔴	🟢

complete emoji choices

2bndy5 · 2022-11-30T20:26:01Z

Or we could hide the summary table in a details tag

Cpp-Linter Report ⚠️

Some files didn't pass the configured checks.

sumary table

file	clang-format	clang-tidy
demo/demo.cpp	🟢	🚫
demo/test.cpp	❌	🚫

shenxianpeng · 2022-12-01T01:55:37Z

I like to hide the summary, but if users don't enable both clang-format and clang-tidy how to show it in the table? maybe a separate display is more suitable.

2bndy5 · 2022-12-01T01:59:25Z

if users don't enable both clang-format and clang-tidy how to show it in the table?

I was thinking we could use 🚫 or ⛔ instead of 🔴/🟢. FYI, the longer the emoji code, the less data we can fit in the comment.

maybe a separate display is more suitable.

What did you have in mind?

shenxianpeng · 2022-12-01T02:47:17Z

Sorry for not being clear. I mean if users only have clang-format checks, we do not need to give them clang-tidy related comments, and vice versa.

so I would like to remove clang-tidy from the table or display it like below as an example.

Cpp-Linter Report ⚠️

Some files didn't pass the configured checks.

Check the details

clang-format - the following files need to be formatted

demo.hpp
demo.cpp

Have any feedback or feature suggestions? Share it here.

2bndy5 · 2022-12-01T03:52:27Z

You know me: anything is possible. I just need a concrete decision before coding the solution.

So, if tidy-checks is '-*' or style is '', then we go with a list. Otherwise we show a table. Yes?

shenxianpeng · 2022-12-01T04:20:35Z

I'm not sure when clang-tidy reports an error, how can we show it in the table? for example in this one #24 (comment)

2bndy5 · 2022-12-01T04:29:43Z

I only suggested the table because

it will reduce the occupied screen real estate when user expands the details.
not showing the info about the reported errors will allow us to fit more summary info in the comment. Remember that the comment's size is limited by the REST API max payload size, so a thread comment about a very large diff (with lots of errors/warnings to report) will be truncated by the REST API's max payload size. There isn't a way around this max limit. I know other actions hide the ending portion of their potentially large comments in a <details> tag just in case the payload is truncated.

2bndy5 · 2022-12-01T04:32:23Z

One thing I noticed about all the example comments you linked to in the OP was that they all show an overview instead of detailed info. So, I thought that was partly what you wanted to mimic.

shenxianpeng · 2022-12-01T05:12:27Z

I'm good with only show an overview with table instead of detailed info.

shenxianpeng · 2022-12-18T01:53:43Z

Cpp-Linter Report ⚠️

Some files didn't pass the configured checks!

clang-format reports: 2 file(s) not formatted

demo/demo.cpp
demo/test.cpp

clang-tidy reports: 7 warning(s)

demo/demo.cpp

demo/demo.cpp:3:10: warning: inclusion of deprecated C++ header 'stdio.h'; consider using 'cstdio' instead [modernize-deprecated-headers]
#include <stdio.h>
         ^~~~~~~~~
         <cstdio>
demo/demo.cpp:8:5: warning: use a trailing return type for this function [modernize-use-trailing-return-type]
int main(){
~~~ ^
auto       -> int
demo/demo.cpp:10:13: warning: statement should be inside braces [readability-braces-around-statements]
    for (;;) break;
            ^
             {
demo/demo.cpp:13:5: warning: do not call c-style vararg functions [cppcoreguidelines-pro-type-vararg]
    printf("Hello world!\n");
    ^

demo/demo.hpp

demo/demo.hpp:6:11: warning: use default member initializer for 'useless' [modernize-use-default-member-init]
    char* useless;
          ^
                 {"\0"}
demo/demo.hpp:7:9: warning: use default member initializer for 'numb' [modernize-use-default-member-init]
    int numb;
        ^
            {0}
demo/demo.hpp:11:11: warning: use a trailing return type for this function [modernize-use-trailing-return-type]
    void *not_useful(char *str){useless = str;}
    ~~~~~~^
    auto                        -> void *

Have any feedback or feature suggestions? Share it here.

Cpp-Linter Report ✔️

No problems need attention.

Have any feedback or feature suggestions? Share it here.

shenxianpeng · 2022-12-28T12:51:56Z

Finally, I‘ve listed both thread comments in my last comment, I've tried to keep it concise and informative. @2bndy5 any thoughts?

2bndy5 · 2022-12-28T20:25:42Z

LGTM

2bndy5 · 2023-01-10T02:01:04Z

I just found an additional feature in github actions: The GITHUB_STEP_SUMMARY will post a markdown content at the bottom of the run's summary. Its not exactly like thread-comments (the markdown payload is the same), but at least we wouldn't have to worry about duplicate bot comments.

Someone even uses the feature in an existing action that produces a unit test summary comment in the workflow's run summary. For example, this run summary shows the custom summary that we could create.

shenxianpeng · 2023-01-10T02:29:35Z

I like this feature!

2bndy5 · 2023-01-10T03:12:19Z

It wouldn't be too hard to implement, we just need to add an input option to turn it on/off and add

with open(os.environ["GITHUB_STEP_SUMMARY"], "a", encoding="utf-8") as summary:
    summary.write(Globals.OUTPUT)

shenxianpeng · 2023-02-18T13:03:28Z

I have tried to add a job summary here, and it's relatively easier to implement.

2bndy5 · 2023-02-18T17:15:28Z

Yep! We don't have to check for duplicate comments and all that entails either.

stale · 2023-04-01T14:30:21Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

2bndy5 · 2023-04-01T14:42:34Z

sorry this still on my todo list, but I've been busy.

stale · 2023-05-01T20:05:16Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

2bndy5 · 2023-05-19T17:23:17Z

Note

I recently noticed that github added support for admonitions (AKA "callouts"). See example here.

Warning

But it looks like only "note" and "warning" are supported (in English only). I also don't like how this looks in dark mode. Block quotes' dimmed text was a bad choice.

shenxianpeng · 2023-05-20T13:16:48Z

I don't know this before, looks like not too bad, tks for sharing!

shenxianpeng added the enhancement New feature or request label Nov 18, 2022

shenxianpeng added the help wanted Extra attention is needed label Feb 3, 2023

2bndy5 mentioned this issue Feb 17, 2023

Cannot get comments displayed on github/pull page cpp-linter/cpp-linter-action#135

Closed

shenxianpeng mentioned this issue Feb 18, 2023

keep all generated files in a cache folder #29

Merged

stale bot added the wontfix This will not be worked on label Apr 1, 2023

stale bot removed the wontfix This will not be worked on label Apr 1, 2023

2bndy5 added a commit that referenced this issue May 19, 2023

change thread comments as suggested in #24

8c56d82

2bndy5 added a commit that referenced this issue May 19, 2023

change thread comments as suggested in #24

fd05ed7

2bndy5 added a commit that referenced this issue May 19, 2023

change thread comments as suggested in #24

147566c

2bndy5 mentioned this issue May 19, 2023

resolves #24 #32

Merged

2bndy5 closed this as completed in 5977c76 May 20, 2023

2bndy5 mentioned this issue Aug 23, 2023

Option to only post thread comment when errors are detected cpp-linter/cpp-linter-action#158

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Reformat action thread comments #24

Reformat action thread comments #24

shenxianpeng commented Nov 18, 2022 •

edited

Loading

2bndy5 commented Nov 18, 2022

2bndy5 commented Nov 26, 2022

shenxianpeng commented Nov 30, 2022

2bndy5 commented Nov 30, 2022

2bndy5 commented Nov 30, 2022 •

edited by shenxianpeng

Loading

shenxianpeng commented Dec 1, 2022

2bndy5 commented Dec 1, 2022

shenxianpeng commented Dec 1, 2022

2bndy5 commented Dec 1, 2022

shenxianpeng commented Dec 1, 2022 •

edited

Loading

2bndy5 commented Dec 1, 2022

2bndy5 commented Dec 1, 2022

shenxianpeng commented Dec 1, 2022 •

edited

Loading

shenxianpeng commented Dec 18, 2022 •

edited

Loading

shenxianpeng commented Dec 28, 2022

2bndy5 commented Dec 28, 2022

2bndy5 commented Jan 10, 2023

shenxianpeng commented Jan 10, 2023

2bndy5 commented Jan 10, 2023 •

edited

Loading

shenxianpeng commented Feb 18, 2023

2bndy5 commented Feb 18, 2023

stale bot commented Apr 1, 2023

2bndy5 commented Apr 1, 2023

stale bot commented May 1, 2023

2bndy5 commented May 19, 2023 •

edited

Loading

shenxianpeng commented May 20, 2023

Reformat action thread comments #24

Reformat action thread comments #24

Comments

shenxianpeng commented Nov 18, 2022 • edited Loading

Cpp-Linter Report ⚠️

Cpp-Linter Report ✔️

2bndy5 commented Nov 18, 2022

2bndy5 commented Nov 26, 2022

Cpp-Linter Report ✔️

shenxianpeng commented Nov 30, 2022

2bndy5 commented Nov 30, 2022

2bndy5 commented Nov 30, 2022 • edited by shenxianpeng Loading

Cpp-Linter Report ⚠️

shenxianpeng commented Dec 1, 2022

2bndy5 commented Dec 1, 2022

shenxianpeng commented Dec 1, 2022

Cpp-Linter Report ⚠️

2bndy5 commented Dec 1, 2022

shenxianpeng commented Dec 1, 2022 • edited Loading

2bndy5 commented Dec 1, 2022

2bndy5 commented Dec 1, 2022

shenxianpeng commented Dec 1, 2022 • edited Loading

shenxianpeng commented Dec 18, 2022 • edited Loading

Cpp-Linter Report ⚠️

Cpp-Linter Report ✔️

shenxianpeng commented Dec 28, 2022

2bndy5 commented Dec 28, 2022

2bndy5 commented Jan 10, 2023

shenxianpeng commented Jan 10, 2023

2bndy5 commented Jan 10, 2023 • edited Loading

shenxianpeng commented Feb 18, 2023

2bndy5 commented Feb 18, 2023

stale bot commented Apr 1, 2023

2bndy5 commented Apr 1, 2023

stale bot commented May 1, 2023

2bndy5 commented May 19, 2023 • edited Loading

shenxianpeng commented May 20, 2023

shenxianpeng commented Nov 18, 2022 •

edited

Loading

2bndy5 commented Nov 30, 2022 •

edited by shenxianpeng

Loading

shenxianpeng commented Dec 1, 2022 •

edited

Loading

shenxianpeng commented Dec 1, 2022 •

edited

Loading

shenxianpeng commented Dec 18, 2022 •

edited

Loading

2bndy5 commented Jan 10, 2023 •

edited

Loading

2bndy5 commented May 19, 2023 •

edited

Loading