Merge pull request #1 from ndkhanh-axonivy/chore/polish-document

Refinement
axonivy-market · Jan 4, 2024 · 8a55716 · 8a55716
2 parents 475aeb8 + d4f61ce
commit 8a55716
Show file tree

Hide file tree

Showing 9 changed files with 105 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,6 @@
-# ups-connector
-UPS connector
+# UPS connector
+[![CI Build](https://github.com/axonivy-market/ups-connector/actions/workflows/ci.yml/badge.svg)](https://github.com/axonivy-market/ups-connector/actions/workflows/ci.yml)
+
+This is a UPS module built in the Axon Ivy framework, enabling users to seamlessly integrate with UPS services. With this app, users can effortlessly manage their packages through UPS.
+
+Read our [documentation](ups-connector-product/README.md).
diff --git a/pom.xml b/pom.xml
@@ -1,9 +1,9 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
   <modelVersion>4.0.0</modelVersion>
-  <groupId>com.axonivy.market</groupId><!-- your group id: e.g. com.axonivy.connector.<myconnector> or com.axonivy.utils.<myutil> -->
-  <name>my-product</name><!-- fill your product name -->
-  <artifactId>my-product-modules</artifactId><!-- fill your product name + a "-modules" postfix -->
-  <version>10.0.0-SNAPSHOT</version><!-- identicate your minimal compliant ivy version with the first 2 digits -->
+  <groupId>com.axonivy.connector.ups</groupId><!-- your group id: e.g. com.axonivy.connector.<myconnector> or com.axonivy.utils.<myutil> -->
+  <name>ups-connector</name><!-- fill your product name -->
+  <artifactId>ups-connector-modules</artifactId><!-- fill your product name + a "-modules" postfix -->
+  <version>10.0.14-SNAPSHOT</version><!-- identicate your minimal compliant ivy version with the first 2 digits -->
   <packaging>pom</packaging>
 
   <modules>

diff --git a/ups-connector-demo/pom.xml b/ups-connector-demo/pom.xml
@@ -2,13 +2,13 @@
 <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <modelVersion>4.0.0</modelVersion>
-  <groupId>ups.connector.demo</groupId>
+  <groupId>com.axonivy.connector.ups</groupId>
   <artifactId>ups-connector-demo</artifactId>
-  <version>1.0.0-SNAPSHOT</version>
+  <version>10.0.14-SNAPSHOT</version>
   <packaging>iar</packaging>
   <dependencies>
     <dependency>
-      <groupId>ups.connector</groupId>
+      <groupId>com.axonivy.connector.ups</groupId>
       <artifactId>ups-connector</artifactId>
       <version>${project.version}</version>
       <type>iar</type>

diff --git a/ups-connector-product/pom.xml b/ups-connector-product/pom.xml
@@ -0,0 +1,7 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+  <groupId>com.axonivy.connector.ups</groupId>
+  <artifactId>ups-connector-product</artifactId>
+  <version>10.0.14-SNAPSHOT</version>
+  <packaging>pom</packaging>
+</project>
diff --git a/ups-connector-product/product.json b/ups-connector-product/product.json
@@ -0,0 +1,49 @@
+{
+  "$schema": "https://json-schema.axonivy.com/market/10.0.0/product.json",
+  "installers": [
+    {
+      "id": "maven-import",
+      "data": {
+        "projects": [
+          {
+            "groupId": "com.axonivy.connector.ups",
+            "artifactId": "ups-connector-demo",
+            "version": "${version}",
+            "type": "iar"
+          }
+        ],
+        "repositories": [
+          {
+            "id": "maven.axonivy.com",
+            "url": "https://maven.axonivy.com",
+            "snapshots": {
+              "enabled": "true"
+            }
+          }
+        ]
+      }
+    },
+    {
+      "id": "maven-dependency",
+      "data": {
+        "dependencies": [
+          {
+            "groupId": "com.axonivy.connector.ups",
+            "artifactId": "ups-connector",
+            "version": "${version}",
+            "type": "iar"
+          }
+        ],
+        "repositories": [
+          {
+            "id": "maven.axonivy.com",
+            "url": "https://maven.axonivy.com",
+            "snapshots": {
+              "enabled": "true"
+            }
+          }
+        ]
+      }
+    }
+  ]
+}
diff --git a/ups-connector-product/zip.xml b/ups-connector-product/zip.xml
@@ -0,0 +1,26 @@
+<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
+  <id>zip</id>
+  <includeBaseDirectory>false</includeBaseDirectory>
+
+  <formats>
+    <format>zip</format>
+  </formats>
+
+  <fileSets>
+    <fileSet>
+      <directory>.</directory>
+      <includes>
+        <include>product.json</include>
+        <include>openapi.json</include>
+        <include>**/*.png</include>
+      </includes>
+    </fileSet>
+    <fileSet>
+      <directory>target</directory>
+      <outputDirectory>/</outputDirectory>
+      <includes>
+        <include>README.md</include>
+      </includes>
+    </fileSet>
+  </fileSets>
+</assembly>
diff --git a/ups-connector-test/pom.xml b/ups-connector-test/pom.xml
@@ -2,15 +2,15 @@
 <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <modelVersion>4.0.0</modelVersion>
-  <groupId>ups.connector.test</groupId>
+  <groupId>com.axonivy.connector.ups</groupId>
   <artifactId>ups-connector-test</artifactId>
-  <version>1.0.0-SNAPSHOT</version>
+  <version>10.0.14-SNAPSHOT</version>
   <packaging>iar</packaging>
   <dependencies>
     <dependency>
-      <groupId>ups.connector</groupId>
+      <groupId>com.axonivy.connector.ups</groupId>
       <artifactId>ups-connector</artifactId>
-      <version>1.0.0</version>
+      <version>10.0.14-SNAPSHOT</version>
       <type>iar</type>
     </dependency>
     <dependency>

diff --git a/ups-connector/pom.xml b/ups-connector/pom.xml
@@ -2,15 +2,15 @@
 <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <modelVersion>4.0.0</modelVersion>
-  <groupId>ups.connector</groupId>
+  <groupId>com.axonivy.connector.ups</groupId>
   <artifactId>ups-connector</artifactId>
-  <version>1.0.0</version>
+  <version>10.0.14-SNAPSHOT</version>
   <packaging>iar</packaging>
   <dependencies>
     <dependency>
-      <groupId>com.ups.oauth.feature</groupId>
+      <groupId>com.axonivy.connector.ups</groupId>
       <artifactId>ups-oauth-feature</artifactId>
-      <version>1.0.0</version>
+      <version>10.0.14-SNAPSHOT</version>
       <type>iar</type>
     </dependency>
   </dependencies>

diff --git a/ups-oauth-feature/pom.xml b/ups-oauth-feature/pom.xml
@@ -2,9 +2,9 @@
 <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <modelVersion>4.0.0</modelVersion>
-  <groupId>com.ups.oauth.feature</groupId>
+  <groupId>com.axonivy.connector.ups</groupId>
   <artifactId>ups-oauth-feature</artifactId>
-  <version>1.0.0</version>
+  <version>10.0.14-SNAPSHOT</version>
   <packaging>iar</packaging>
   <scm>
     <developerConnection>scm:git:https://github.com/axonivy-market/${project.name}.git</developerConnection>