dockerzhang commented on code in PR #7031: URL: https://github.com/apache/inlong/pull/7031#discussion_r1056109281
########## inlong-tools/dev/README.md: ########## @@ -0,0 +1,96 @@ +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you 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. + +--> + +# InLong dev toolkit + +## Motivation + +The InLong project includes modules such as `dashboard`, `dataproxy`, `manager`, and `tubemq`. When +debugging in the development environment such as `Intellij IDEA`, it faces the problem that the +environment is difficult to build. + +The `inlong-manager` project relies on too many configurations and packages. When debugging locally +in IDE, multiple default directories need to be created, which is complicated. +Therefore, a script is urgently needed to quickly support local debugging. + +Furthermore, local debugging of other modules also requires similar tools. Temporarily named devkit, +looking forward to the addition of more functions. + +## Use case + +### Help + + + +### Manager + +Rely of Manager: + +| Directory/File | link target | Rely modules | +|--------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------|---------------------------------| +| `./plugins` | `inlong-manager/manger-plugins/target/plugins` | `inlong-sort/sort-plugin` | +| `./inlong-sort/connectors` | - | `inlong-sort/sort-connectors/*` | | +| `./inlong-sort/connectors/sort-connector-${name}-${project.version}.jar` | `inlong-sort/sort-connectors/${connector.name}/target/sort-connector-${connector.name}-${project.version}.jar` | `inlong-sort/sort-connectors/*` | +| `./sort-dist.jar` | `sort-dist/target/sort-dist-${project.version}.jar` | `inlong-sort/sort-dist` | + +```shell +inlong-tools/dev/inlong-dev-toolkit.sh m +``` + + Review Comment: Please remove the image. ########## inlong-tools/dev/README.md: ########## @@ -0,0 +1,96 @@ +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you 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. + +--> + +# InLong dev toolkit Review Comment: InLong -> Apache InLong and please start with secondary title(##) ########## inlong-tools/dev/inlong-dev-toolkit.sh: ########## @@ -0,0 +1,146 @@ +#!/bin/bash +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You 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. +# Initialize the configuration files of inlong components + +script_dir=$(dirname "$0") +script_file_name=$(basename "$0") + +# the absolute dir of project +base_dir=$(cd $script_dir; cd ../..; pwd) + +help_action=( + 'help' + 'h' + 'help' + 'welcome' +) + +manager_action=( + 'manager' + 'm' + 'build manager local debugging environment' + 'manager' +) + +actions=( + help_action + manager_action +) + + +function welcome() { + echo '####################################################################################' + echo '# Welcome to use InLong dev toolkit ! #' Review Comment: InLong -> Apache InLong ########## inlong-tools/dev/README.md: ########## @@ -0,0 +1,96 @@ +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you 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. + +--> + +# InLong dev toolkit + +## Motivation + +The InLong project includes modules such as `dashboard`, `dataproxy`, `manager`, and `tubemq`. When Review Comment: dashboard -> Dashbaord dataproxy -> DataProxy manager -> Manager tubemq -> TubeMQ ########## inlong-tools/dev/README.md: ########## @@ -0,0 +1,96 @@ +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you 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. + +--> + +# InLong dev toolkit + +## Motivation + +The InLong project includes modules such as `dashboard`, `dataproxy`, `manager`, and `tubemq`. When +debugging in the development environment such as `Intellij IDEA`, it faces the problem that the +environment is difficult to build. + +The `inlong-manager` project relies on too many configurations and packages. When debugging locally +in IDE, multiple default directories need to be created, which is complicated. +Therefore, a script is urgently needed to quickly support local debugging. + +Furthermore, local debugging of other modules also requires similar tools. Temporarily named devkit, +looking forward to the addition of more functions. + +## Use case + +### Help + + Review Comment: Please remove the image. -- 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-unsubscr...@inlong.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
