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

Feature: add repo_path_prefix argument for non-standard repo path. #25

Merged
merged 1 commit into from
Apr 24, 2022

Conversation

caic99
Copy link
Contributor

@caic99 caic99 commented Apr 24, 2022

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.

Copy link
Owner

@platisd platisd left a 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'
Copy link
Owner

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.

Copy link
Contributor Author

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?

Copy link
Owner

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? 🙏

Copy link
Contributor Author

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.

@caic99
Copy link
Contributor Author

caic99 commented Apr 24, 2022

It looks like it's probably fine. Do you have a run with and without it showing how the error was fixed?

Here is the case with this patch. It worked as expected!
I'm sorry that I don't have a test running without this argument to ensure its correctness.

@platisd platisd merged commit 6f016d0 into platisd:master Apr 24, 2022
herculanodavi added a commit to herculanodavi/esp-idf-template that referenced this pull request Dec 19, 2022
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.

Failed to match codes between repo and fixes.yml.
2 participants