Skip to content

Commit f47cc1d

Browse files
clunclun
committed
Start documentation and improve test
1 parent d5781cd commit f47cc1d

File tree

111 files changed

+2605
-166
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

111 files changed

+2605
-166
lines changed

‎pom.xml

Lines changed: 53 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,30 @@
88
<name>+ astra-db-java</name>
99
<version>1.0.0-SNAPSHOT</version>
1010
<description>Java Client for Data API JAVA </description>
11+
<url>https://github.com/datastax/astra-db-java</url>
12+
<inceptionYear>2024</inceptionYear>
1113

1214
<properties>
15+
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
16+
17+
<!-- Sonar -->
18+
<sonar.organization>clun-datastax</sonar.organization>
19+
<sonar.host.url>https://sonarcloud.io</sonar.host.url>
1320

1421
<!-- Third Party Libraries -->
22+
<devops-sdk.version>1.2.7</devops-sdk.version>
1523
<slf4j.version>2.0.9</slf4j.version>
1624
<logback.version>1.5.0</logback.version>
1725
<jackson.version>2.16.2</jackson.version>
1826
<lombok.version>1.18.32</lombok.version>
19-
<assertj.version>3.25.3</assertj.version>
20-
<devops-sdk.version>1.2.7</devops-sdk.version>
2127
<retry4j.version>0.15.0</retry4j.version>
22-
<junit-jupiter.version>5.10.2</junit-jupiter.version>
2328
<uuid-generator.version>5.0.0</uuid-generator.version>
2429

30+
<!-- Test -->
31+
<test.skipped>false</test.skipped>
32+
<assertj.version>3.25.3</assertj.version>
33+
<junit-jupiter.version>5.10.2</junit-jupiter.version>
34+
2535
<!-- Maven -->
2636
<maven.plugin.compiler.source>11</maven.plugin.compiler.source>
2737
<maven.plugin.compiler.target>11</maven.plugin.compiler.target>
@@ -32,6 +42,7 @@
3242
<version.maven.plugin.jacoco>0.8.11</version.maven.plugin.jacoco>
3343
<version.maven.plugin.javadoc>3.5.0</version.maven.plugin.javadoc>
3444
<version.maven.plugin.jar>3.3.0</version.maven.plugin.jar>
45+
<version.maven.plugin.license>2.3.0</version.maven.plugin.license>
3546
<version.maven.plugin.nexus>1.6.13</version.maven.plugin.nexus>
3647
<version.maven.plugin.release>3.0.1</version.maven.plugin.release>
3748
<version.maven.plugin.resources>3.3.1</version.maven.plugin.resources>
@@ -127,6 +138,7 @@
127138
<!-- Client is JDK11+ -->
128139
<build>
129140
<plugins>
141+
130142
<plugin>
131143
<groupId>org.sonatype.plugins</groupId>
132144
<artifactId>nexus-staging-maven-plugin</artifactId>
@@ -139,30 +151,27 @@
139151
<skipLocalStaging>true</skipLocalStaging>
140152
</configuration>
141153
</plugin>
154+
142155
<plugin>
143156
<groupId>org.apache.maven.plugins</groupId>
144157
<artifactId>maven-gpg-plugin</artifactId>
145158
<version>${version.maven.plugin.gpg}</version>
146159
</plugin>
160+
147161
<plugin>
148162
<groupId>org.apache.maven.plugins</groupId>
149163
<artifactId>maven-source-plugin</artifactId>
150164
<version>${version.maven.plugin.source}</version>
151165
<executions>
152166
<execution>
153167
<id>attach-sources</id>
154-
155168
<goals>
156-
157169
<goal>jar-no-fork</goal>
158-
159170
</goals>
160-
161171
</execution>
162-
163172
</executions>
164-
165173
</plugin>
174+
166175
<plugin>
167176
<groupId>org.apache.maven.plugins</groupId>
168177
<artifactId>maven-release-plugin</artifactId>
@@ -175,6 +184,7 @@
175184
<goals>deploy</goals>
176185
</configuration>
177186
</plugin>
187+
178188
<plugin>
179189
<groupId>org.apache.maven.plugins</groupId>
180190
<artifactId>maven-compiler-plugin</artifactId>
@@ -185,12 +195,13 @@
185195
<showWarnings>false</showWarnings>
186196
</configuration>
187197
</plugin>
198+
188199
<plugin>
189200
<groupId>org.apache.maven.plugins</groupId>
190201
<artifactId>maven-surefire-plugin</artifactId>
191202
<version>${version.maven.plugin.surefire}</version>
192203
<configuration>
193-
<skipTests>true</skipTests>
204+
<skipTests>${test.skipped}</skipTests>
194205
</configuration>
195206
<dependencies>
196207
<dependency>
@@ -200,6 +211,7 @@
200211
</dependency>
201212
</dependencies>
202213
</plugin>
214+
203215
<plugin>
204216
<groupId>org.apache.maven.plugins</groupId>
205217
<artifactId>maven-javadoc-plugin</artifactId>
@@ -216,11 +228,13 @@
216228
<source>${maven.plugin.compiler.source}</source>
217229
</configuration>
218230
</plugin>
231+
219232
<plugin>
220233
<groupId>org.apache.maven.plugins</groupId>
221234
<artifactId>maven-dependency-plugin</artifactId>
222235
<version>${version.maven.plugin.dependency}</version>
223236
</plugin>
237+
224238
<plugin>
225239
<groupId>org.apache.maven.plugins</groupId>
226240
<artifactId>maven-jar-plugin</artifactId>
@@ -234,6 +248,7 @@
234248
</archive>
235249
</configuration>
236250
</plugin>
251+
237252
<plugin>
238253
<groupId>org.apache.maven.plugins</groupId>
239254
<artifactId>maven-resources-plugin</artifactId>
@@ -243,35 +258,34 @@
243258
<encoding>UTF-8</encoding>
244259
</configuration>
245260
</plugin>
246-
247261
<plugin>
248-
<groupId>org.jacoco</groupId>
249-
<artifactId>jacoco-maven-plugin</artifactId>
250-
<version>${version.maven.plugin.jacoco}</version>
262+
<groupId>org.codehaus.mojo</groupId>
263+
<artifactId>license-maven-plugin</artifactId>
264+
<version>${version.maven.plugin.license}</version>
265+
<configuration>
266+
<verbose>false</verbose>
267+
<extraExtensions>
268+
<myProprietaryExtension>java</myProprietaryExtension>
269+
</extraExtensions>
270+
</configuration>
251271
<executions>
252272
<execution>
253-
<id>default-prepare-agent</id>
254-
<goals>
255-
<goal>prepare-agent</goal>
256-
</goals>
257-
</execution>
258-
<execution>
259-
<id>default-prepare-agent-integration</id>
260-
<goals>
261-
<goal>prepare-agent-integration</goal>
262-
</goals>
263-
</execution>
264-
<execution>
265-
<id>default-report</id>
266-
<goals>
267-
<goal>report</goal>
268-
</goals>
269-
</execution>
270-
<execution>
271-
<id>default-report-integration</id>
273+
<id>add-license</id>
272274
<goals>
273-
<goal>report-integration</goal>
275+
<goal>update-file-header</goal>
274276
</goals>
277+
<phase>process-sources</phase>
278+
<configuration>
279+
<projectName>Data API Java Client</projectName>
280+
<organizationName>DataStax</organizationName>
281+
<licenseName>apache2</licenseName>
282+
<licenseResolver>${project.baseUri}/src/license</licenseResolver>
283+
<addJavaLicenseAfterPackage>true</addJavaLicenseAfterPackage>
284+
<sectionDelimiter>--</sectionDelimiter>
285+
<roots>
286+
<root>src/main/java</root>
287+
</roots>
288+
</configuration>
275289
</execution>
276290
</executions>
277291
</plugin>
@@ -332,6 +346,11 @@
332346
</profile>
333347
</profiles>
334348

349+
<!-- Organization -->
350+
<organization>
351+
<name>DataStax</name>
352+
<url>https://www.datastax.com</url>
353+
</organization>
335354

336355
<!-- Release the client with Apache License -->
337356
<licenses>

‎src/license/apache2/header.txt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Licensed under the Apache License, Version 2.0
2+
You may not use this file except in compliance with the License.
3+
You may obtain a copy of the License at
4+
5+
http://www.apache.org/licenses/LICENSE-2.0
6+
7+
Unless required by applicable law or agreed to in writing, software
8+
distributed under the License is distributed on an "AS IS" BASIS,
9+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
10+
See the License for the specific language governing permissions and
11+
limitations under the License.

0 commit comments

Comments
 (0)