You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by GitBox <gi...@apache.org> on 2022/08/08 07:12:43 UTC

[GitHub] [dolphinscheduler] EricGao888 opened a new issue, #11347: [Feature][Development] Install pre-commit hook automatically and Add doc checks

EricGao888 opened a new issue, #11347:
URL: https://github.com/apache/dolphinscheduler/issues/11347

   ### Search before asking
   
   - [X] I had searched in the [issues](https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue) and found no similar feature requirement.
   
   
   ### Description
   
   * Currently we need developers to copy example `pre-commit hook` script into their `.git/hooks` directory. For convenience, we could do this for developers by triggering a script to copy the hook during first-time compilation of the project. 
   * We could add doc checks in `pre-commit hook` to make sure updated docs are cool before developers pushing them and triggering the remote CI.
   
   ### Use case
   
   * Already described above.
   
   ### Related issues
   
   _No response_
   
   ### Are you willing to submit a PR?
   
   - [X] Yes I am willing to submit a PR!
   
   ### Code of Conduct
   
   - [X] I agree to follow this project's [Code of Conduct](https://www.apache.org/foundation/policies/conduct)
   


-- 
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: commits-unsubscribe@dolphinscheduler.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [dolphinscheduler] github-actions[bot] commented on issue #11347: [Feature][Development] Install pre-commit hook automatically and add doc checks

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on issue #11347:
URL: https://github.com/apache/dolphinscheduler/issues/11347#issuecomment-1207753444

   Thank you for your feedback, we have received your issue, Please wait patiently for a reply.
   * In order for us to understand your request as soon as possible, please provide detailed information、version or pictures.
   * If you haven't received a reply for a long time, you can [join our slack](https://s.apache.org/dolphinscheduler-slack) and send your question to channel `#troubleshooting`


-- 
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: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [dolphinscheduler] EricGao888 commented on issue #11347: [Feature][Development] Install pre-commit hook automatically and add doc checks

Posted by GitBox <gi...@apache.org>.
EricGao888 commented on issue #11347:
URL: https://github.com/apache/dolphinscheduler/issues/11347#issuecomment-1207756027

   IMHO, by performing some easy checks in `pre-commit hook`, we could reduce the stress of remote CI a bit.


-- 
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: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [dolphinscheduler] zhongjiajie commented on issue #11347: [Feature][Development] Install pre-commit hook automatically and add doc checks

Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on issue #11347:
URL: https://github.com/apache/dolphinscheduler/issues/11347#issuecomment-1207804815

   And in module `dolphinscheudler-python` we also have https://github.com/apache/dolphinscheduler/blob/cfb5918e7492b209db118d528878663ff808ca8e/dolphinscheduler-python/pydolphinscheduler/.pre-commit-config.yaml#L25-L35 but in barely use it. One reason is that I have tox for better choices https://github.com/apache/dolphinscheduler/blob/cfb5918e7492b209db118d528878663ff808ca8e/dolphinscheduler-python/pydolphinscheduler/tox.ini#L24-L29.
   
   But I do not find some tool in Java, so maybe we can use pre-commit for a shot


-- 
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: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [dolphinscheduler] EricGao888 commented on issue #11347: [Feature][Development] Install pre-commit hook automatically and add doc checks

Posted by GitBox <gi...@apache.org>.
EricGao888 commented on issue #11347:
URL: https://github.com/apache/dolphinscheduler/issues/11347#issuecomment-1207797706

   > Maybe you can see the pre-commit project https://pre-commit.com. But I have had some bad experiences with it, such as:
   > 
   > * Slow: Obviously, because we have to check locally
   > * Update: when `pre-commit-config` file change, development have to update the pre-commit hook, otherwise they will failed in the github action. Also developer have to update both github action and `pre-commit-config` when then change the check rule
   
   Thanks for the information. I agree with that we should not have too many checks in `pre-commit hook` to avoid it getting too slow. Currently our `pre-commit hook` takes about 1 minute in totally to run `mvn spotless:apply` and I think it's fine.


-- 
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: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [dolphinscheduler] zhongjiajie commented on issue #11347: [Feature][Development] Install pre-commit hook automatically and add doc checks

Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on issue #11347:
URL: https://github.com/apache/dolphinscheduler/issues/11347#issuecomment-1207794491

   Maybe you can see the pre-commit project https://pre-commit.com. But I have had some bad experiences with it, such as:
   * Slow: Obviously, because we have to check locally
   * Update: when `pre-commit-config` file change, development have to update the pre-commit hook, otherwise they will failed in the github action. Also developer have to update both github action and `pre-commit-config` when then change the check rule


-- 
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: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org

[GitHub] [dolphinscheduler] zhongjiajie commented on issue #11347: [Feature][Development] Install pre-commit hook automatically and add doc checks

Posted by GitBox <gi...@apache.org>.
zhongjiajie commented on issue #11347:
URL: https://github.com/apache/dolphinscheduler/issues/11347#issuecomment-1207795538

   you can see it here https://github.com/apache/airflow/blob/a562cc396212e4d21484088ac5f363ade9ac2b8d/.pre-commit-config.yaml#L300-L308 about how to run local script into pre-commit


-- 
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: commits-unsubscribe@dolphinscheduler.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org