-
Notifications
You must be signed in to change notification settings - Fork 22
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
Feature: add repo_path_prefix
argument for non-standard repo path.
#25
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It looks like it's probably fine. Do you have a run with and without it showing how the error was fixed?
Also, what do you think @oleg-derevenetz?
action.yml
Outdated
@@ -19,6 +19,10 @@ inputs: | |||
description: 'The number of suggestions per comment (smaller numbers work better for heavy pull requests)' | |||
required: false | |||
default: '10' | |||
repo_path_prefix: | |||
description: 'The path to repo when codes are analyzed with clang-tidy' |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you briefly specify the exact use case here?
We need to illustrate that users typically don't need that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need to illustrate that users typically don't need that.
For users don't need that, the default setting works just like the former hard-coded bash script, and the implement details keep opaque for users.
Can you briefly specify the exact use case here?
It's necessary for users who run clang-tidy
in a docker container. I considered this before, but it might be too long to put the introduction in the "description" field. Maybe providing a showcase for it in readme.md
? What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can add something like may be needed for users who run clang-tidy in a docker container
.
I understand that the default value will work for most, however those who dive in deeper shouldn't lose time looking into a parameter that may not concern them. :)
Also, can you also change when codes are analyzed
to when code is analyzed
? 🙏
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@platisd Sure! I've updated instructions as you suggested. Sorry for my English.
Here is the case with this patch. It worked as expected! |
Probably fixes #23 by setting
repo_path_prefix
as/__w
when using docker image for clang-tidy.P.S. I found it hard to describe this argument and its usage; any suggestions are welcomed.