richardantal commented on code in PR #116: URL: https://github.com/apache/phoenix-omid/pull/116#discussion_r952686687
########## dev/code-coverage/README.md: ########## @@ -0,0 +1,40 @@ +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +# Clover code analysis + +The `run-coverage.sh` script runs maven with the code-coverage profile which generates +the clover code analysis data. +If the necessary parameters are given it also uploads the results to SonarQube. + +## Running code coverage + +The coverage results can be found under `target/clover/index.html` and here is how you can run the clover code analysis: + +```sh dev-support/code-coverage/run-coverage.sh``` Review Comment: I think this location should be dev/code-coverage/run-coverage.sh ########## dev/code-coverage/README.md: ########## @@ -0,0 +1,40 @@ +<!-- + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +# Clover code analysis + +The `run-coverage.sh` script runs maven with the code-coverage profile which generates +the clover code analysis data. +If the necessary parameters are given it also uploads the results to SonarQube. + +## Running code coverage + +The coverage results can be found under `target/clover/index.html` and here is how you can run the clover code analysis: + +```sh dev-support/code-coverage/run-coverage.sh``` + +## Publishing coverage results to SonarQube + +The required parameters for publishing to SonarQube are: + +- host URL, +- login credentials, +- project key + +The project name is an optional parameter. + +Here is an example command for running and publishing the coverage data: + +`sh dev-support/code-coverage/run-coverage.sh -l ProjectCredentials -u https://exampleserver.com Review Comment: dev/code-coverage/run-coverage.sh here as well. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
