search

apache / kyuubi

Apache Kyuubi is a distributed and multi-tenant gateway to provide serverless SQL on data warehouses and lakehouses.
https://kyuubi.apache.org/
Apache License 2.0
2.09k stars 913 forks source link

[Improvement] .gitignore File Excluding Essential Source Files #5984

Closed qijiale76 closed 9 months ago

qijiale76 commented 9 months ago

Code of Conduct

Search before asking

What would you like to be improved?

After downloading the source code of the project from https://github.com/apache/kyuubi/releases/tag/v1.8.0 and initializing a new Git repository using git init, I noticed an unexpected behavior when executing git add .. It appears that the .gitignore file is inadvertently excluding some essential source files. Specifically, files like kyuubi-hive-jdbc/main/java/org/apache/kyuubi/jdbc/hive/logs/InPlaceUpdateStream.java are being omitted because of logs/ line in .gitignore file. This exclusion results in an incomplete codebase being added to the new Git repository.

I believe that modifying the .gitignore file to fix this issue would enhance the development experience.

How should we improve?

I have finished a comparison of the files in the new Git repository created using git add . against those in the community repository. This comparison is based on version 1.8.0 of the project.

 .github/ISSUE_TEMPLATE/bug-report.yml                                    |  136 ----
 .github/ISSUE_TEMPLATE/config.yml                                        |   28 -
 .github/ISSUE_TEMPLATE/dependency.yml                                    |  109 ---
 .github/ISSUE_TEMPLATE/documentation.yml                                 |   85 --
 .github/ISSUE_TEMPLATE/feature-request.yml                               |   94 ---
 .github/ISSUE_TEMPLATE/improve-test.yml                                  |   77 --
 .github/ISSUE_TEMPLATE/improvement.yml                                   |   77 --
 .github/ISSUE_TEMPLATE/subtask.yml                                       |   71 --
 .github/ISSUE_TEMPLATE/umbrella.yml                                      |   81 --
 .github/PULL_REQUEST_TEMPLATE                                            |   32 -
 .github/actions/cache-engine-archives/action.yaml                        |   27 -
 .github/actions/setup-maven/action.yaml                                  |   31 -
 .github/actions/tune-runner-vm/action.yml                                |   30 -
 .github/labeler.yml                                                      |  127 ---
 .github/workflows/dep.yml                                                |   75 --
 .github/workflows/docs.yml                                               |   48 --
 .github/workflows/greetings.yml                                          |   41 -
 .github/workflows/labeler.yml                                            |   34 -
 .github/workflows/license.yml                                            |   54 --
 .github/workflows/master.yml                                             |  574 -------------
 .github/workflows/nightly.yml                                            |   57 --
 .github/workflows/publish-snapshot-docker.yml                            |   51 --
 .github/workflows/publish-snapshot-nexus.yml                             |   57 --
 .github/workflows/stale.yml                                              |   43 -
 .github/workflows/style.yml                                              |  145 ----
 .github/workflows/web-ui.yml                                             |   55 --
 .idea/icon.png                                                           |  Bin 1179 -> 0 bytes
 .idea/vcs.xml                                                            |   36 -
 LICENSE-binary                                                           |  506 ------------
 NOTICE-binary                                                            | 1386 --------------------------------
 bin/beeline                                                              |    0
 bin/docker-image-tool.sh                                                 |    0
 bin/kyuubi                                                               |    0
 bin/kyuubi-admin                                                         |    0
 bin/kyuubi-ctl                                                           |    0
 bin/kyuubi-logo                                                          |    0
 bin/kyuubi-zk-cli                                                        |    0
 bin/load-kyuubi-env.sh                                                   |    0
 bin/stop-application.sh                                                  |    0
 build/dependency.sh                                                      |    0
 build/dist                                                               |    0
 build/kyuubi-build-info                                                  |    0
 build/kyuubi-build-info.cmd                                              |    0
 build/mvn                                                                |    0
 build/release/append_notice.py                                           |    0
 build/release/collect-licenses.sh                                        |    0
 build/release/create-package.sh                                          |    0
 build/release/release.sh                                                 |    0
 build/release/script/announce.sh                                         |    0
 build/release/script/dev_kyuubi_vote.sh                                  |    0
 build/util.sh                                                            |    0
 codecov.yml                                                              |   19 -
 conf/kyuubi-env.sh.template                                              |    0
 dev/checkout_pr.sh                                                       |    0
 dev/gen/gen_all_config_docs.sh                                           |    0
 dev/gen/gen_hive_kdf_docs.sh                                             |    0
 dev/gen/gen_ranger_policy_json.sh                                        |    0
 dev/gen/gen_ranger_spec_json.sh                                          |    0
 dev/gen/gen_spark_kdf_docs.sh                                            |    0
 dev/gen/gen_tpcds_output_schema.sh                                       |    0
 dev/gen/gen_tpcds_queries.sh                                             |    0
 dev/gen/gen_tpch_queries.sh                                              |    0
 bin/docker-image-tool.sh                                                 |    0
 bin/kyuubi                                                               |    0
 bin/kyuubi-admin                                                         |    0
 bin/kyuubi-ctl                                                           |    0
 bin/kyuubi-logo                                                          |    0
 bin/kyuubi-zk-cli                                                        |    0
 bin/load-kyuubi-env.sh                                                   |    0
 bin/stop-application.sh                                                  |    0
 build/dependency.sh                                                      |    0
 build/dist                                                               |    0
 build/kyuubi-build-info                                                  |    0
 build/kyuubi-build-info.cmd                                              |    0
 build/mvn                                                                |    0
 build/release/append_notice.py                                           |    0
 build/release/collect-licenses.sh                                        |    0
 build/release/create-package.sh                                          |    0
 build/release/release.sh                                                 |    0
 build/release/script/announce.sh                                         |    0
 build/release/script/dev_kyuubi_vote.sh                                  |    0
 build/util.sh                                                            |    0
 codecov.yml                                                              |   19 -
 conf/kyuubi-env.sh.template                                              |    0
 dev/checkout_pr.sh                                                       |    0
 dev/gen/gen_all_config_docs.sh                                           |    0
 dev/gen/gen_hive_kdf_docs.sh                                             |    0
 dev/gen/gen_ranger_policy_json.sh                                        |    0
 dev/gen/gen_ranger_spec_json.sh                                          |    0
 dev/gen/gen_spark_kdf_docs.sh                                            |    0
 dev/gen/gen_tpcds_output_schema.sh                                       |    0
 dev/gen/gen_tpcds_queries.sh                                             |    0
 dev/gen/gen_tpch_queries.sh                                              |    0
 dev/merge_kyuubi_pr.py                                                   |    0
 dev/reformat                                                             |    0
 docker/playground/build-image.sh                                         |    0
 .../org/apache/hive/beeline/logs/KyuubiBeelineInPlaceUpdateStream.java   |   99 ---
 .../main/java/org/apache/kyuubi/jdbc/hive/logs/InPlaceUpdateStream.java  |   69 --
 .../src/main/java/org/apache/kyuubi/jdbc/hive/logs/KyuubiLoggable.java   |   42 -
 .../main/scala/org/apache/kyuubi/metrics/ConsoleReporterService.scala    |   42 -
 .../src/main/scala/org/apache/kyuubi/metrics/JMXReporterService.scala    |   39 -
 .../src/main/scala/org/apache/kyuubi/metrics/JsonReporterService.scala   |   82 --
 .../src/main/scala/org/apache/kyuubi/metrics/MetricsConf.scala           |   88 --
 .../src/main/scala/org/apache/kyuubi/metrics/MetricsConstants.scala      |   95 ---
 .../src/main/scala/org/apache/kyuubi/metrics/MetricsSystem.scala         |  129 ---
 .../main/scala/org/apache/kyuubi/metrics/PrometheusReporterService.scala |   90 ---
 .../src/main/scala/org/apache/kyuubi/metrics/ReporterType.scala          |   25 -
 .../src/main/scala/org/apache/kyuubi/metrics/Slf4jReporterService.scala  |   45 --
 .../src/test/scala/org/apache/kyuubi/metrics/MetricsSystemSuite.scala    |   97 ---
 kyuubi-server/src/main/resources/dist/index.html                         |   28 -
 kyuubi-server/src/test/resources/tpcds-1_4/q1/q1.sql                     |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q10/q10.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q11/q11.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q12/q12.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q13/q13.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q14/q14a.sql                  |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q14/q14b.sql                  |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q15/q15.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q16/q16.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q17/q17.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q18/q18.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q19/q19.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q2/q2.sql                     |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q20/q20.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q21/q21.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q22/q22.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q23/q23a.sql                  |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q23/q23b.sql                  |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q24/q24a.sql                  |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q24/q24b.sql                  |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q25/q25.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q26/q26.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q27/q27.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q28/q28.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q29/q29.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q3/q3.sql                     |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q30/q30.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q31/q31.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q32/q32.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q33/q33.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q34/q34.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q35/q35.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q36/q36.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q37/q37.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q38/q38.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q39/q39a.sql                  |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q39/q39b.sql                  |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q4/q4.sql                     |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q40/q40.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q41/q41.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q42/q42.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q43/q43.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q44/q44.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q45/q45.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q46/q46.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q47/q47.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q48/q48.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q49/q49.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q5/q5.sql                     |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q50/q50.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q51/q51.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q52/q52.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q53/q53.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q54/q54.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q55/q55.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q56/q56.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q57/q57.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q58/q58.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q59/q59.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q6/q6.sql                     |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q60/q60.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q61/q61.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q62/q62.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q63/q63.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q64/q64.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q65/q65.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q66/q66.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q67/q67.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q68/q68.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q69/q69.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q7/q7.sql                     |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q70/q70.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q71/q71.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q72/q72.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q73/q73.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q74/q74.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q75/q75.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q76/q76.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q77/q77.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q78/q78.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q79/q79.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q8/q8.sql                     |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q80/q80.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q81/q81.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q82/q82.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q83/q83.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q84/q84.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q85/q85.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q86/q86.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q87/q87.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q88/q88.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q89/q89.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q9/q9.sql                     |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q90/q90.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q91/q91.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q92/q92.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q93/q93.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q94/q94.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q95/q95.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q96/q96.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q97/q97.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q98/q98.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q99/q99.sql                   |    0
 dev/gen/gen_spark_kdf_docs.sh                                            |    0
 dev/gen/gen_tpcds_output_schema.sh                                       |    0
 dev/gen/gen_tpcds_queries.sh                                             |    0
 dev/gen/gen_tpch_queries.sh                                              |    0
 dev/merge_kyuubi_pr.py                                                   |    0
 dev/reformat                                                             |    0
 docker/playground/build-image.sh                                         |    0
 .../org/apache/hive/beeline/logs/KyuubiBeelineInPlaceUpdateStream.java   |   99 ---
 .../main/java/org/apache/kyuubi/jdbc/hive/logs/InPlaceUpdateStream.java  |   69 --
 .../src/main/java/org/apache/kyuubi/jdbc/hive/logs/KyuubiLoggable.java   |   42 -
 .../main/scala/org/apache/kyuubi/metrics/ConsoleReporterService.scala    |   42 -
 .../src/main/scala/org/apache/kyuubi/metrics/JMXReporterService.scala    |   39 -
 .../src/main/scala/org/apache/kyuubi/metrics/JsonReporterService.scala   |   82 --
 .../src/main/scala/org/apache/kyuubi/metrics/MetricsConf.scala           |   88 --
 .../src/main/scala/org/apache/kyuubi/metrics/MetricsConstants.scala      |   95 ---
 .../src/main/scala/org/apache/kyuubi/metrics/MetricsSystem.scala         |  129 ---
 .../main/scala/org/apache/kyuubi/metrics/PrometheusReporterService.scala |   90 ---
 .../src/main/scala/org/apache/kyuubi/metrics/ReporterType.scala          |   25 -
 .../src/main/scala/org/apache/kyuubi/metrics/Slf4jReporterService.scala  |   45 --
 .../src/test/scala/org/apache/kyuubi/metrics/MetricsSystemSuite.scala    |   97 ---
 kyuubi-server/src/main/resources/dist/index.html                         |   28 -
 kyuubi-server/src/test/resources/tpcds-1_4/q1/q1.sql                     |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q10/q10.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q11/q11.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q12/q12.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q13/q13.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q14/q14a.sql                  |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q14/q14b.sql                  |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q15/q15.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q16/q16.sql                   |    0
 kyuubi-server/src/test/resources/tpcds-1_4/q17/q17.sql                   |    0

Are you willing to submit PR?

github-actions[bot] commented 9 months ago

Hello @qijiale76, Thanks for finding the time to report the issue! We really appreciate the community's efforts to improve Apache Kyuubi.

pan3793 commented 9 months ago

... downloading the source code of the project from https://github.com/apache/kyuubi/releases/tag/v1.8.0 and initializing a new Git repository using git init ...

This does not seem like a common practice, I don't get your idea. We use the .gitignore to avoid tracking unexpected files by git add ., but users always can forcibly add files via git add -f abc.log

pan3793 commented 9 months ago

Close as not a problem