6512 documentation on GitHub gating#4634
Conversation
dkrupp
left a comment
dkrupp
left a comment
There was a problem hiding this comment.
please add instructions as how to run the gating script locally
| ### Code quality | ||
|
|
||
| Any change in the Pull Request against the codechecker repository will be checked | ||
| with CodeChecker itself for potential issues. If any issue found, the Pull Request |
| # ... your code here | ||
| ``` | ||
|
|
||
| ### Code quality |
There was a problem hiding this comment.
I think it would be good to write down in this section which script should be run locally and from where to check the gating criteria ...
There was a problem hiding this comment.
I'd make a different user for this to avoid "demo" users find the production checks. Make codechecker product invisible to "demo" user.
gulyasgergely902
force-pushed
the
6512-documentation-on-github-gating
branch
2 times, most recently
from
66e49b6 to
3b55b48
Compare
|
|
||
| * Run `ci/github_analysis/codechecker_gate_pr.sh` to analyze the code. | ||
|
|
||
| __Important:__ Make sure you are running CodeChecker 6.25.1 when running the script! |
There was a problem hiding this comment.
If this version is hardcoded elsewhere, it needs to be referenced in the developer docs, as it needs changing on a new release.
There was a problem hiding this comment.
The version 6.25.1 is required since the server which the gating is using, runs CodeChecker 6.25.1 and the version matching is required. If the server will be updated to a new version, then can this version be updated as well.
There was a problem hiding this comment.
I guess the requirement is that the client needs to be newer than the 6.25.1 (the server version), isn't it?
So I think we should write here that the client used must be always on a lower version than the server at https://codechecker-demo.eastus.cloudapp.azure.com
There was a problem hiding this comment.
The requirement is the client must be on the same or lower version than the server so in this case it should be 6.25.1 or lower. I'll modify it so it reflects this.
Fix some issues found by markdownlint in contributing guide
Add a paragraph about codechecker checking the pull request.
gulyasgergely902
force-pushed
the
6512-documentation-on-github-gating
branch
from
b6ccd7e to
66acdda
Compare
3 participants
Add documentation on GitHub PR gating with CodeChecker into CONTRIBUTING.md