Automating SDK generation process

.github/actions/notify-slack/action.yml

@@ -0,0 +1,103 @@
+name: slack-alert-action
+description: "Action to send slack payload to public-sdk-events channel"
+
+inputs:
+  heading_text:
+    required: true
+    description: "Heading of the slack payload"
+  alert_type:
+    required: true
+    description: "type of the slack alert"
+  job_status:
+    required: true
+    description: "status of the job"
+  XERO_SLACK_WEBHOOK_URL:
+    required: true
+    description: "webhook url for channel - public-sdk-events"
+  job_url:
+    required: true
+    description: "job run id link"
+  button_type:
+    required: true
+    description: "color for the check logs button"
+  package_version:
+    required: true
+    description: "released package version"
+  repo_link:
+    required: true
+    description: "link of the repo"
+
+
+runs:
+  using: "composite"
+
+  steps:
+
+      - name: Send slack notification
+        id: slack
+        uses: slackapi/[email protected]
+        env:
+          SLACK_WEBHOOK_URL: ${{inputs.XERO_SLACK_WEBHOOK_URL}}
+          SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK
+        with:
+         payload: |
+          {
+            "blocks": [
+              {
+                "type": "rich_text",
+                "elements": [
+                  {
+                    "type": "rich_text_section",
+                    "elements": [
+                      {
+                        "type": "text",
+                        "text": "${{inputs.heading_text}} ",
+                        "style": {
+                          "bold": true
+                        }
+                      },
+                      {
+                        "type": "emoji",
+                        "name": "${{inputs.alert_type}}"
+                      }
+                    ]
+                  }
+                ]
+              },
+              {
+                "type": "divider"
+              },
+             {
+                "type": "section",
+                "fields": [
+                  {
+                    "type": "mrkdwn",
+                    "text": "*Repository:* \n ${{inputs.repo_link}}"
+                  },
+                  {
+                    "type": "mrkdwn",
+                    "text": "*Status:*\n ${{inputs.job_status}}"
+                  },
+                  {
+                    "type": "mrkdwn",
+                    "text": "*Package Version:*\n ${{inputs.package_version}}"
+                  }
+                ]
+              },
+              {
+                "type": "actions",
+                "elements": [
+                  {
+                    "type": "button",
+                    "text": {
+                      "type": "plain_text",
+                      "text": "Check the logs",
+                      "emoji": true
+                  },
+                    "style": "${{inputs.button_type}}",
+                    "url": "${{inputs.job_url}}"
+                  }
+                ]
+              }
+            ]
+          }

.github/workflows/build-lint-test.yml

@@ -27,8 +27,26 @@ jobs:
               env: 
                 GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY}}
 
+            - name: Set up Node environment
+              uses: actions/setup-node@v2
+              with:
+                node-version: 20
+
+            - name: Install Prism
+              run: npm install -g @stoplight/prism-cli
+
+            - name: Start PRISM Server
+              run: ./start-prism.sh & sleep 15
+              working-directory: Xero-Java/src/test/java/com/xero/api/util
+
             - name: Build and test post generation
               run: |
                 export GPG_TTY=$(tty)
-                mvn clean verify -DskipTests=true -Dgpg.passphrase=${{ secrets.GPG_PASSPHRASE }}  
+                mvn clean verify
+              env:
+                MAVEN_GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}  
+              working-directory: Xero-Java
+
+            - name: Stop PRISM
+              run: pkill -f prism
               working-directory: Xero-Java

.github/workflows/publish.yml

@@ -0,0 +1,104 @@
+name: Publish
+on:
+    release:
+        types: [published]
+
+jobs:
+    publish:
+        runs-on: ubuntu-latest
+
+        outputs:
+          release_number: ${{steps.get_latest_release_number.outputs.release_tag}}
+        permissions:
+          contents: write
+          pull-requests: write
+
+        steps:
+            - name: Checkout Xero-Java repo
+              uses: actions/checkout@v4
+              with:
+                repository: XeroAPI/Xero-Java
+                path: Xero-Java
+
+            - name: Set up JDK environment
+              uses: actions/setup-java@v4
+              with: 
+                distribution: 'temurin'
+                java-version: '11'
+                cache: maven
+                server-id: ossrh
+                server-username: MAVEN_USERNAME
+                server-password: MAVEN_PASSWORD
+                gpg-passphrase: GPG_PASSPHRASE
+
+            - name: Fetch Latest release number
+              id: get_latest_release_number
+              run: |
+                  latest_version=$(gh release view --json tagName --jq '.tagName')
+                  echo "Latest release version is - $latest_version"
+                  echo "::set-output name=release_tag::$latest_version"
+              working-directory: Xero-Java
+              env:
+                 GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+            - name: Import GPG Key
+              run: |
+                echo "${{ secrets.GPG_PRIVATE_KEY }}" | gpg --batch --import
+              env: 
+                GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY}}
+
+            - name: Publish to Maven
+              run: |
+                export GPG_TTY=$(tty)
+                mvn clean deploy -DskipTests=true
+              env:
+                MAVEN_USERNAME: ${{ secrets.MAVEN_USERNAME }}
+                MAVEN_PASSWORD: ${{ secrets.MAVEN_TOKEN }}
+                GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
+              working-directory: Xero-Java
+
+    notify-slack-on-success:
+      runs-on: ubuntu-latest
+      needs: publish
+      if: success()
+      steps:
+        - name: Checkout Xero-Java repo
+          uses: actions/checkout@v4
+          with:
+            repository: XeroAPI/Xero-Java
+            path: Xero-Java
+
+        - name: Send slack notification on success
+          uses: ./Xero-Java/.github/actions/notify-slack
+          with:
+            heading_text: "Publish job has succeeded !"
+            alert_type: "thumbsup"
+            job_status: "Success"
+            XERO_SLACK_WEBHOOK_URL: ${{secrets.XERO_SLACK_WEBHOOK_URL}}
+            job_url: "https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}"
+            button_type: "primary"
+            package_version: ${{needs.publish.outputs.release_number}}
+            repo_link: ${{github.server_url}}/${{github.repository}}
+
+    notify-slack-on-failure:
+      runs-on: ubuntu-latest
+      needs: publish
+      if: failure()
+      steps:
+        - name: Checkout Xero-Java repo
+          uses: actions/checkout@v4
+          with:
+            repository: XeroAPI/Xero-Java
+            path: Xero-Java
+
+        - name: Send slack notification on failure
+          uses: ./Xero-Java/.github/actions/notify-slack
+          with:
+            heading_text: "Publish job has failed !"
+            alert_type: "alert"
+            job_status: "Failed"
+            XERO_SLACK_WEBHOOK_URL: ${{secrets.XERO_SLACK_WEBHOOK_URL}}
+            job_url: "https://github.com/${{github.repository}}/actions/runs/${{github.run_id}}"
+            button_type: "danger"
+            package_version: ${{needs.publish.outputs.release_number}}
+            repo_link: ${{github.server_url}}/${{github.repository}}

README.md

@@ -15,6 +15,7 @@ The **Xero-Java** SDK makes it easy for developers to access Xero's APIs in thei
 - [App Store Subscriptions](#app-store-subscriptions)
 - [API Clients](#api-clients)
 - [Usage Examples](#usage-examples)
+- [Running Test(s) in Local](#running-tests-in-local)
 - [SDK conventions](#sdk-conventions)
 - [Participating in Xero’s developer community](#participating-in-xeros-developoer-community)
 
@@ -677,7 +678,17 @@ try {
     System.out.println(e.getMessage());
 }
 ```
+## Running Test(s) in Local
+For Running Test cases PRISM Mock Server needs to be started in the local machine.
+Steps to Run Test(s)
+* Install PRISM from npm using the command:  **npm install -g @stoplight/prism-cli**
+* Verify Installation: **prism --version**
+* Navigate to **Xero-Java--> src--> test--> util** folder in the terminal
+* Execute the script **./start-prism.sh**
+* This will start the PRISM Server in Local
+* Run **mvn clean verify -DskipTests=false** to build the Java code along with Test Cases.
 
+---
 ## SDK conventions
 
 ### Working with dates