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

add coveralls auto tool to json-c #541

Merged
merged 2 commits into from Mar 28, 2020
Merged

Conversation

dota17
Copy link
Member

@dota17 dota17 commented Feb 18, 2020

This PR adds the coveralls auto tool to json-c. Coveralls is a web service to help you track your code coverage over time, and ensure that all your new code is fully covered.

I have added it in dota17/json-c and showed a PR submission example in here. We can see the json-c's code coverage in README.md and get the code coverage report from coveralls automatically when you submit a PR. It is a useful and helpful tool.

Following are the configuration steps:

  1. Sign in the https://coveralls.io/ with github account and open the switch of json-c/json-c in ADD REPO .
  2. configure file:
    2020-02-18_111510
    2020-02-18_111913
    2020-02-18_112032
    note: Compact means that you will get a neat and clear report.
  3. Merge this pr.
  4. Get and add the badge into README.md
    2020-02-18_112847
    These steps are simple and coveralls is an interesting and useful tool. You will like it. (‐^▽^‐)

@dota17
Copy link
Member Author

dota17 commented Feb 18, 2020

And, we should choose suitable files to report. In here, I have chosen the most of the .c files and partial .h files.

Copy link
Member

@hawicz hawicz left a comment

Choose a reason for hiding this comment

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

Showing test coverage sounds like a good idea. However, is it really worth it to pull in another separate service to do that? It seems that we should be able to get the same percent coverage simple out of gcov and/or lcov.

.travis.yml Outdated Show resolved Hide resolved
CMakeLists.txt Outdated Show resolved Hide resolved
@dota17
Copy link
Member Author

dota17 commented Feb 19, 2020

I have modified the .travis.yml. And I think it is necessary and worthy to run it in a separate service. It won't affect other services.

@dota17
Copy link
Member Author

dota17 commented Feb 19, 2020

Because json-c/json-c repository does not have the usage rights of coveralls, this PR could not pass. I suggest you give the permission to Coveralls as the steps shown in PR description.(‐^▽^‐) @hawicz

@dota17
Copy link
Member Author

dota17 commented Feb 25, 2020

@hawicz I have modified the .travis.yml. The CI couldn't pass and maybe need you to give the permission to Coveralls. Coveralls has provided a lot of convenience for community submission and code testing. It really is a good tool, ≧◉◡◉≦

@dota17
Copy link
Member Author

dota17 commented Mar 23, 2020

@hawicz I have opened the permissions of Coveralls and the CI has passed. Do you have any other opinions on this?

@dota17
Copy link
Member Author

dota17 commented Mar 27, 2020

This PR is not associated with the core code, so I will merge it. We can try it out. If it is not suitable, we can revise/delete it.

@dota17 dota17 closed this Mar 27, 2020
@dota17 dota17 reopened this Mar 28, 2020
@dota17 dota17 merged commit d1650a5 into json-c:master Mar 28, 2020
@dota17 dota17 deleted the coveralls_final branch April 17, 2020 02:24
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.

None yet

2 participants