diff --git a/.github/workflows/commit_lint.yml b/.github/workflows/commit_lint.yml new file mode 100644 index 0000000..0bd90b9 --- /dev/null +++ b/.github/workflows/commit_lint.yml @@ -0,0 +1,12 @@ +name: commit lint +on: + pull_request: + branches: + - main + +jobs: + commitlint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: wagoid/commitlint-github-action@v5 diff --git a/.github/workflows/java_checkstyle.yml b/.github/workflows/java_checkstyle.yml new file mode 100644 index 0000000..cdec2a7 --- /dev/null +++ b/.github/workflows/java_checkstyle.yml @@ -0,0 +1,21 @@ +name: java checkstyle +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + java_checkstyle: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Maven Central Repository + uses: actions/setup-java@v4 + with: + java-version: '17' + distribution: 'temurin' + - name: checkstyle + run: mvn -B clean checkstyle:check diff --git a/.github/workflows/java_spotbugs.yml b/.github/workflows/java_spotbugs.yml new file mode 100644 index 0000000..2881b05 --- /dev/null +++ b/.github/workflows/java_spotbugs.yml @@ -0,0 +1,21 @@ +name: java spotbugs +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + java_spotbugs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Maven Central Repository + uses: actions/setup-java@v4 + with: + java-version: '17' + distribution: 'temurin' + - name: spotbugs + run: mvn -B -DskipTests clean verify spotbugs:spotbugs diff --git a/.github/workflows/java_spotless.yml b/.github/workflows/java_spotless.yml new file mode 100644 index 0000000..1dfcf9a --- /dev/null +++ b/.github/workflows/java_spotless.yml @@ -0,0 +1,21 @@ +name: java spotless +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + java_spotless: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Maven Central Repository + uses: actions/setup-java@v4 + with: + java-version: '17' + distribution: 'temurin' + - name: spotless + run: mvn -B spotless:check diff --git a/.github/workflows/java_unit_tests.yml b/.github/workflows/java_unit_tests.yml new file mode 100644 index 0000000..fce4571 --- /dev/null +++ b/.github/workflows/java_unit_tests.yml @@ -0,0 +1,21 @@ +name: java unit tests +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + java_unit_tests: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Set up Maven Central Repository + uses: actions/setup-java@v4 + with: + java-version: '17' + distribution: 'temurin' + - name: unit tests + run: mvn -B clean test diff --git a/.github/workflows/line_lint.yml b/.github/workflows/line_lint.yml new file mode 100644 index 0000000..222e062 --- /dev/null +++ b/.github/workflows/line_lint.yml @@ -0,0 +1,13 @@ +name: line lint +on: + pull_request: + branches: + - main +jobs: + line_lint: + name: line lint + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: linelint + uses: fernandrone/linelint@master diff --git a/.github/workflows/typo_check.yml b/.github/workflows/typo_check.yml new file mode 100644 index 0000000..b89a9f9 --- /dev/null +++ b/.github/workflows/typo_check.yml @@ -0,0 +1,13 @@ +name: typo check +on: + pull_request: + branches: + - main +jobs: + typo_check: + name: typo check + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - name: Check typos + uses: crate-ci/typos@master diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6e99d4e --- /dev/null +++ b/.gitignore @@ -0,0 +1,26 @@ +# file system +.DS_Store + +# ide +.idea/** +!.idea/icon.svg +!.idea/vcs.xml + +# Project exclude paths +**.log +**/target +**/.classpath +**/.project +**/.factorypath + +# gradle +.gradle/** +**/build/** + +# mvn shade plugin +dependency-reduced-pom.xml + +# log file +logs/ + +*.xml.releaseBackup diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..80ccdcd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e21870 --- /dev/null +++ b/README.md @@ -0,0 +1 @@ +# mtconnect-java diff --git a/ci/spotbugs/exclude.xml b/ci/spotbugs/exclude.xml new file mode 100644 index 0000000..2ff8e64 --- /dev/null +++ b/ci/spotbugs/exclude.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/mtconnect-parent.iml b/mtconnect-parent.iml new file mode 100644 index 0000000..3b0c98f --- /dev/null +++ b/mtconnect-parent.iml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..6da510c --- /dev/null +++ b/pom.xml @@ -0,0 +1,308 @@ + + + 4.0.0 + + io.github.protocol-laboratory + mtconnect-parent + 0.0.1-SNAPSHOT + pom + + + + + + 17 + 17 + UTF-8 + src/main/java + + 5.11.0 + 2.20.0 + 1.18.34 + 2.0.16 + + 1.18.20.0 + 3.13.0 + 3.5.0 + 3.8.0 + 3.2.5 + 3.10.0 + 3.1.1 + 2.1.0 + 3.3.1 + 3.5.0 + 1.7.0 + 4.8.6.2 + 2.43.0 + + + + + org.projectlombok + lombok + ${lombok.version} + + + org.junit.jupiter + junit-jupiter-engine + ${junit.version} + test + + + + + ${src.dir} + + + org.apache.maven.plugins + maven-enforcer-plugin + ${maven-enforcer-plugin.version} + + + enforce-versions + + enforce + + + + + ${maven-enforce-plugin-maven.version} + + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + ${maven-compiler-plugin.version} + + ${maven.compiler.source} + ${maven.compiler.target} + + + + com.github.spotbugs + spotbugs-maven-plugin + ${spotbugs-maven-plugin.version} + + true + true + ci/spotbugs/exclude.xml + + + + + check + + + + + + org.apache.maven.plugins + maven-surefire-plugin + ${maven-surefire-plugin.version} + true + + false + + + + com.diffplug.spotless + spotless-maven-plugin + ${spotless-maven-plugi.version} + + + + ,java,static others + + + + + + true + 4 + + + + + + org.apache.maven.plugins + maven-release-plugin + ${maven-release-plugin.version} + + true + false + forked-path + -Dgpg.passphrase=${gpg.passphrase} + + + + org.apache.maven.scm + maven-scm-provider-gitexe + ${maven-scm-provider-gitexe.version} + + + + + org.apache.maven.plugins + maven-javadoc-plugin + ${maven-javadoc-plugin.version} + + ${src.dir} + all,-missing + + + + attach-java-docs + + jar + + + + + + org.apache.maven.plugins + maven-source-plugin + ${maven-source-plugin.version} + + + attach-sources + + jar-no-fork + + + + + + org.sonatype.plugins + nexus-staging-maven-plugin + ${nexus-staging-maven-plugin.version} + true + + ossrh + https://s01.oss.sonatype.org/ + true + + + + + + MTConnect Java + MTConnect Java implementation + https://github.com/protocol-laboratory/mtconnect-java + + + Apache License, Version 2.0 + https://www.apache.org/licenses/LICENSE-2.0 + + + + + protocol-laboratory + https://github.com/protocol-laboratory + + + + + shoothzj + shoothzj@gmail.com + + + + + scm:git:git@github.com:protocol-laboratory/mtconnect-java.git + scm:git:git@github.com:protocol-laboratory/mtconnect-java.git + git@github.com:protocol-laboratory/mtconnect-java.git + HEAD + + + + + ossrh + https://s01.oss.sonatype.org/content/repositories/snapshots/ + + + ossrh + https://s01.oss.sonatype.org/service/local/staging/deploy/maven2/ + + + + + + release-sign-artifacts + + + performRelease + true + + + + + + org.apache.maven.plugins + maven-gpg-plugin + ${maven-gpg-plugin.version} + + + sign-artifacts + verify + + sign + + + + + ${gpg.passphrase} + + --pinentry-mode + loopback + + + + + + + + delombok + + ${project.build.directory}/generated-sources/delombok + + + + + org.projectlombok + lombok-maven-plugin + ${lombok-maven-plugin.version} + + + org.projectlombok + lombok + ${lombok.version} + + + + + generate-sources + + delombok + + + false + src/main/java + + + + + + + + + + + + +