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

Readme no docker & allow using platform default version #66

Merged
merged 11 commits into from
Jun 20, 2022

Conversation

2bndy5
Copy link
Collaborator

@2bndy5 2bndy5 commented Jun 19, 2022

  • re-write section of README about using the action source code as a python package.
    • updated example and added example about CLI args compared to action input options.
  • resolves tidy-checks always applied nevetherless local .clang-tidy #64 about using clang-tidy with only a config file.
  • allow version input option to be blank.
    • When using the docker, the version default is 10.
    • When using the python CLI approach, the version is a blank string (allowing the platform's default installed version to be invoked).

@2bndy5 2bndy5 requested a review from shenxianpeng June 19, 2022 00:26
@2bndy5 2bndy5 marked this pull request as draft June 19, 2022 00:41
@2bndy5 2bndy5 changed the title Readme no docker Readme no docker & allow using platform default version Jun 19, 2022
@2bndy5 2bndy5 marked this pull request as ready for review June 19, 2022 01:08
Copy link
Collaborator

@shenxianpeng shenxianpeng left a comment

Choose a reason for hiding this comment

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

LTGM. Especially I like the example about CLI args compared to action input options.

I just don’t know whether the code change will break something because we don't have a full regression test.

Maybe I can move the test-cpp-linter-action to this org and add some test cases for testing in short term.

Maybe we could add some unit tests for Python code in the long term.

@2bndy5
Copy link
Collaborator Author

2bndy5 commented Jun 19, 2022

I thought you'd eventually transfer the test repo over also. I'd like to merge the cpp-linter/test-cpp-linter-action#10. The updated workflows will be a good base for testing with and without the docker image.

I also agree that the code changes should be tested. The idea to change the version default (for only python CLI) came to me as I was re-writing the example for this PR. We needed a way to explicitly allow using the default version of clang tools in the platform's PATH env var.

@2bndy5
Copy link
Collaborator Author

2bndy5 commented Jun 20, 2022

I tested the version default in this CI run. It worked like a charm (and 15 seconds faster).

The changes to version option doesn't have an affect when using the docker image because the action.yml still passes 10 as the default value when the user doesn't specify a value (verified as such with this CI run). These changes to the version option only affect running the action as a python executable.

Other than those changes, the README update is the only thing left to review.

@shenxianpeng shenxianpeng merged commit 6981fa9 into master Jun 20, 2022
@shenxianpeng shenxianpeng deleted the readme-no-docker branch June 20, 2022 07:15
@shenxianpeng shenxianpeng added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

tidy-checks always applied nevetherless local .clang-tidy
2 participants