Update POM file for NotificationAPI Java Server SDK to include project metadata, change license to Apache 2.0, and configure distribution management for Maven Central. Modify README for clarity and update GitHub Actions workflow to publish to Maven Central with GPG signing support.

.github/workflows/publish.yml

@@ -3,84 +3,101 @@ name: Publish Package
 on:
   push:
     branches: [ main ]
+  release:
+    types: [created]
 
 jobs:
-  publish:
+  build:
     runs-on: ubuntu-latest
 
     steps:
     - uses: actions/checkout@v3
-    
-    - name: Set up JDK 11
+
+    - name: Set up JDK 17
       uses: actions/setup-java@v3
       with:
-        java-version: '11'
+        java-version: '17'
         distribution: 'temurin'
-        cache: 'maven'
-        server-id: github
-        settings-path: ${{ github.workspace }}
+        cache: maven
 
-    - name: Notify Build Start
-      uses: 8398a7/action-slack@v3
-      with:
-        status: custom
-        fields: repo,message,commit,workflow
-        custom_payload: |
-          {
-            "text": "🚀 Starting build and publish for notificationapi-java-server-sdk",
-            "attachments": [{
-              "color": "good",
-              "fields": [
-                {
-                  "title": "Repository",
-                  "value": "{repo}",
-                  "short": true
-                },
-                {
-                  "title": "Commit",
-                  "value": "{commit}",
-                  "short": true
-                }
-              ]
-            }]
-          }
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
+    - name: Import GPG key
+      run: |
+        # Setup GPG directory
+        mkdir -p ~/.gnupg
+        chmod 700 ~/.gnupg
 
-    - name: Build with Maven
-      run: mvn -B package --file pom.xml
-
-    - name: Run tests
-      run: mvn -B test --file pom.xml
-
-    - name: Check code style
-      run: mvn -B checkstyle:check --file pom.xml
-
-    - name: Generate Javadoc
-      run: mvn -B javadoc:javadoc --file pom.xml
-
-    - name: Publish to GitHub Packages
-      run: mvn --batch-mode deploy
-      env:
-        GITHUB_TOKEN: ${{ secrets.PACKAGES_TOKEN }}
-
-    - name: Notify Success
-      if: success()
-      uses: 8398a7/action-slack@v3
-      with:
-        status: ${{ job.status }}
-        fields: repo,message,commit,workflow,took
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        SLACK_WEBHOOK_URL: ${{ secrets.SLACK_SUCCESS_WEBHOOK_URL }}
+        # Write key to file
+        echo "${{ secrets.GPG_PRIVATE_KEY }}" > ~/private.key
+
+        # Import the key
+        gpg --batch --import ~/private.key
+
+        # Clean up
+        rm ~/private.key
+
+        # Extract key ID from the imported key
+        GPG_KEY_ID=$(gpg --list-secret-keys --keyid-format LONG | grep sec | awk '{print $2}' | cut -d'/' -f2)
+        echo "Imported GPG key ID: $GPG_KEY_ID"
+        echo "GPG_KEY_ID=$GPG_KEY_ID" >> $GITHUB_ENV
 
-    - name: Notify Failure
-      if: failure()
-      uses: 8398a7/action-slack@v3
-      with:
-        status: ${{ job.status }}
-        fields: repo,message,commit,workflow,took
+    - name: Build and Publish with Maven
       env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        SLACK_WEBHOOK_URL: ${{ secrets.SLACK_FAILED_WEBHOOK_URL }} 
+        OSSRH_USERNAME: ${{ secrets.OSSRH_USERNAME }}
+        OSSRH_TOKEN: ${{ secrets.OSSRH_TOKEN }}
+        GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
+      run: |
+        # Create settings.xml file
+        mkdir -p ~/.m2
+        cat > ~/.m2/settings.xml << EOF
+        <?xml version="1.0" encoding="UTF-8"?>
+        <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
+            xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+            xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd">
+            <servers>
+                <server>
+                    <id>central</id>
+                    <username>\${env.OSSRH_USERNAME}</username>
+                    <password>\${env.OSSRH_TOKEN}</password>
+                </server>
+                <server>
+                    <id>gpg.passphrase</id>
+                    <passphrase>\${env.GPG_PASSPHRASE}</passphrase>
+                </server>
+            </servers>
+            <profiles>
+                <profile>
+                    <id>gpg</id>
+                    <properties>
+                        <gpg.keyname>\${env.GPG_KEY_ID}</gpg.keyname>
+                        <gpg.passphrase>\${env.GPG_PASSPHRASE}</gpg.passphrase>
+                        <gpg.executable>gpg</gpg.executable>
+                    </properties>
+                </profile>
+                <profile>
+                    <id>central</id>
+                    <activation>
+                        <activeByDefault>true</activeByDefault>
+                    </activation>
+                    <properties>
+                        <central.username>\${env.OSSRH_USERNAME}</central.username>
+                        <central.password>\${env.OSSRH_TOKEN}</central.password>
+                    </properties>
+                </profile>
+            </profiles>
+            <activeProfiles>
+                <activeProfile>gpg</activeProfile>
+                <activeProfile>central</activeProfile>
+            </activeProfiles>
+        </settings>
+        EOF
+
+        # Debug GPG configuration
+        echo "Using GPG key ID: $GPG_KEY_ID"
+        gpg --list-keys $GPG_KEY_ID
+
+        # Set environment variables and run Maven with debug for GPG
+        export OSSRH_USERNAME=${{ secrets.OSSRH_USERNAME }}
+        export OSSRH_TOKEN="${{ secrets.OSSRH_TOKEN }}"
+        export GPG_PASSPHRASE=${{ secrets.GPG_PASSPHRASE }}
+
+        mvn clean deploy -Dgpg.keyname=$GPG_KEY_ID -Dgpg.passphrase=$GPG_PASSPHRASE -Dcentral.username=$OSSRH_USERNAME -Dcentral.password=$OSSRH_TOKEN --settings ~/.m2/settings.xml

.github/workflows/pull-request.yml

@@ -20,6 +20,12 @@ jobs:
         java-version: ${{ matrix.java }}
         distribution: 'temurin'
         cache: 'maven'
+        server-id: central
+        server-username: ${{ secrets.OSSRH_USERNAME }}
+        server-password: ${{ secrets.OSSRH_TOKEN }}
+        gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
+        gpg-passphrase: ${{ secrets.GPG_PASSPHRASE }}
+        settings-path: ${{ github.workspace }}
 
     - name: Build with Maven
       run: mvn -B package --file pom.xml
@@ -31,4 +37,5 @@ jobs:
       run: mvn -B checkstyle:check --file pom.xml
 
     - name: Generate Javadoc
-      run: mvn -B javadoc:javadoc --file pom.xml 
+      run: mvn -B javadoc:javadoc --file pom.xml
+

.gitignore

@@ -0,0 +1,35 @@
+# Maven
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+.mvn/wrapper/maven-wrapper.jar
+
+# IDE files
+.idea/
+*.iml
+.vscode/
+.project
+.classpath
+.settings/
+
+# Compiled files
+*.class
+*.jar
+*.war
+*.ear
+*.zip
+*.tar.gz
+*.rar
+
+# Logs
+*.log
+
+# OS specific
+.DS_Store
+Thumbs.db 

README.md

@@ -4,7 +4,7 @@ This is the official Java Server SDK for [NotificationAPI](https://www.notificat
 
 ## Installation
 
-Add the following dependency to your `pom.xml` file:
+Add the following dependency to your project's `pom.xml`:
 
 ```xml
 <dependency>
@@ -82,7 +82,3 @@ try (NotificationApi api = new NotificationApi(clientId, clientSecret)) {
 
 - Java 11 or later
 - Maven or Gradle build system
-
-## License
-
-This project is licensed under the MIT License - see the LICENSE file for details. 

checkstyle.xml

@@ -0,0 +1,91 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+          "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+          "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<module name="Checker">
+    <property name="charset" value="UTF-8"/>
+    <property name="severity" value="warning"/>
+    <property name="fileExtensions" value="java"/>
+
+    <!-- Excludes all 'module-info.java' files -->
+    <module name="BeforeExecutionExclusionFileFilter">
+        <property name="fileNamePattern" value="module\-info\.java$"/>
+    </module>
+
+    <!-- Checks for whitespace -->
+    <module name="FileTabCharacter">
+        <property name="eachLine" value="true"/>
+    </module>
+
+    <module name="LineLength">
+        <property name="max" value="120"/>
+        <property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
+    </module>
+
+    <module name="TreeWalker">
+        <!-- Import checks -->
+        <module name="AvoidStarImport"/>
+        <module name="IllegalImport"/>
+        <module name="RedundantImport"/>
+        <module name="UnusedImports"/>
+
+        <!-- Checks for Naming Conventions -->
+        <module name="ConstantName"/>
+        <module name="LocalFinalVariableName"/>
+        <module name="LocalVariableName"/>
+        <module name="MemberName"/>
+        <module name="MethodName"/>
+        <module name="PackageName"/>
+        <module name="ParameterName"/>
+        <module name="StaticVariableName"/>
+        <module name="TypeName"/>
+
+        <!-- Checks for Size Violations -->
+        <module name="MethodLength"/>
+        <module name="ParameterNumber"/>
+
+        <!-- Checks for whitespace -->
+        <module name="EmptyForIteratorPad"/>
+        <module name="GenericWhitespace"/>
+        <module name="MethodParamPad"/>
+        <module name="NoWhitespaceAfter"/>
+        <module name="NoWhitespaceBefore"/>
+        <module name="OperatorWrap"/>
+        <module name="ParenPad"/>
+        <module name="TypecastParenPad"/>
+        <module name="WhitespaceAfter"/>
+        <module name="WhitespaceAround"/>
+
+        <!-- Modifier Checks -->
+        <module name="ModifierOrder"/>
+        <module name="RedundantModifier"/>
+
+        <!-- Checks for blocks -->
+        <module name="AvoidNestedBlocks"/>
+        <module name="EmptyBlock"/>
+        <module name="LeftCurly"/>
+        <module name="NeedBraces"/>
+        <module name="RightCurly"/>
+
+        <!-- Checks for common coding problems -->
+        <module name="EmptyStatement"/>
+        <module name="EqualsHashCode"/>
+        <module name="IllegalInstantiation"/>
+        <module name="InnerAssignment"/>
+        <module name="MissingSwitchDefault"/>
+        <module name="MultipleVariableDeclarations"/>
+        <module name="SimplifyBooleanExpression"/>
+        <module name="SimplifyBooleanReturn"/>
+
+        <!-- Checks for class design -->
+        <module name="FinalClass"/>
+        <module name="InterfaceIsType"/>
+        <module name="VisibilityModifier"/>
+
+        <!-- Miscellaneous other checks -->
+        <module name="ArrayTypeStyle"/>
+        <module name="TodoComment"/>
+        <module name="UpperEll"/>
+    </module>
+</module>