Devesh/sk 2837 update v1 readme

.cspell.json

@@ -0,0 +1,111 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "allowCompoundWords": true,
+  "files": [
+    "**/*.{java,md,xml,yml,yaml,json,txt,properties}"
+  ],
+  "words": [
+    "Skyflow",
+    "skyflow",
+    "skyflowapi",
+    "skyflowapis",
+    "skyflow-java",
+    "detokenize",
+    "Detokenize",
+    "detokenizing",
+    "detokenized",
+    "tokenize",
+    "Tokenize",
+    "tokenized",
+    "tokenization",
+    "reidentify",
+    "Reidentify",
+    "reidentified",
+    "re-identify",
+    "Re-identify",
+    "re-identification",
+    "deidentify",
+    "Deidentify",
+    "deidentified",
+    "de-identify",
+    "De-identify",
+    "de-identification",
+    "de-identifying",
+    "upsert",
+    "upserting",
+    "upserted",
+    "BYOT",
+    "skyflowId",
+    "skyflow_id",
+    "skyflowIds",
+    "apikey",
+    "Gson",
+    "gson",
+    "okhttp",
+    "OkHttp",
+    "jjwt",
+    "Jwts",
+    "jaxb",
+    "dotenv",
+    "powermock",
+    "mvn",
+    "sonatype",
+    "jfrog",
+    "prekarilabs",
+    "Gradle",
+    "gradle",
+    "mavenCentral",
+    "blackbox",
+    "Params",
+    "deidentifying",
+    "deidentification",
+    "Deidentification",
+    "println",
+    "cdimascio",
+    "gsonfire",
+    "javax",
+    "Creds",
+    "creds",
+    "javac",
+    "PKCS",
+    "Pkcs",
+    "pkcs",
+    "prioritise",
+    "Prioritise",
+    "Timeto",
+    "Wdex",
+    "jacoco"
+  ],
+  "languageSettings": [
+    {
+      "languageId": "java",
+      "locale": "*",
+      "ignoreRegExpList": [
+        "/\\b[A-Z][A-Z0-9_]{2,}\\b/g",
+        "/^package\\s+.*/m",
+        "/^import\\s+.*/m"
+      ]
+    }
+  ],
+  "ignorePaths": [
+    ".git/**",
+    ".github/**",
+    "target/**",
+    "**/target/**",
+    "*.lock",
+    "Rule/**",
+    "src/main/java/com/skyflow/generated/**",
+    "**/*.ts",
+    "**/processed-*",
+    "samples/src/main/java/com/example/credentials.json"
+  ],
+  "ignoreRegExpList": [
+    "/\\b[A-Z][A-Z0-9_]{2,}\\b/g",
+    "/https?:\\/\\/[^\\s]*/g",
+    "/(eyJ[A-Za-z0-9+/=_-]+\\.)+[A-Za-z0-9+/=_-]+/g",
+    "/[A-Za-z0-9_.~-]*%[0-9A-Fa-f]{2}[A-Za-z0-9_.~%-]*/g",
+    "/\\b[A-Za-z0-9_]{7,}\\b(?=])/g",
+    "/\"[A-Za-z0-9+/=]{15,}\"/g"
+  ]
+}

.github/workflows/beta-release.yml

@@ -0,0 +1,20 @@
+name: Public beta release
+on:
+  push:
+    tags: '*.*.*-beta.*'
+jobs:
+  build-and-deploy:
+    uses: ./.github/workflows/shared-build-and-deploy.yml
+    with:
+      ref: ${{ github.ref_name }}
+      server-id: central
+      profile: maven-central
+      tag: 'beta'
+    secrets:
+      server-username: ${{ secrets.CENTRAL_PUBLISHER_PORTAL_USERNAME }}
+      server-password: ${{ secrets.CENTRAL_PUBLISHER_PORTAL_PASSWORD }}
+      gpg-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
+      gpg-passphrase: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+      skyflow-credentials: ${{ secrets.SKYFLOW_CREDENTIALS }} >> .env
+      test-expired-token: ${{ secrets.TEST_EXPIRED_TOKEN }} >> .env
+      test-reusable-token: ${{ secrets.TEST_REUSABLE_TOKEN }} >> .env

.github/workflows/endorlabsScan.yml

@@ -37,7 +37,7 @@ jobs:
           json: ${{ secrets.TEST_CREDENTIALS_FILE_STRING }}
 
       - name: Compile Package
-        run: mvn -B package -DTEST_VAULT_ID=${{ secrets.TEST_VAULT_ID }} -DTEST_VAULT_URL=${{ secrets.TEST_VAULT_URL }} -DTEST_SKYFLOW_ID=${{ secrets.TEST_SKYFLOW_ID }} -DTEST_TOKEN=${{ secrets.TEST_TOKEN }} -DTEST_CREDENTIALS=${{ secrets.TEST_CREDENTIALS_FILE_STRING }} -DTEST_EXPIRED_TOKEN=${{ secrets.TEST_EXPIRED_TOKEN }} -DTEST_REUSABLE_TOKEN=${{ secrets.TEST_REUSABLE_TOKEN }} -DSKYFLOW_CREDENTIALS=${{ secrets.SKYFLOW_CREDENTIALS }} -f pom.xml
+        run: mvn -B package -f pom.xml -Dmaven.javadoc.skip=true
 
       - name: Endor Labs SCA Scan
         uses: endorlabs/github-action@main
@@ -47,4 +47,4 @@ jobs:
           pr: false
           enable_github_action_token: true
           scan_dependencies: true
-          additional_args: "--as-default-branch --call-graph-languages=java"
+          additional_args: "--as-default-branch --call-graph-languages=java"

.github/workflows/internal-release.yml

@@ -1,9 +1,9 @@
 name: Publish package to the JFROG Artifactory
 on:
   push:
-    tags: '*.*.*'
+    tags-ignore:
+      - '*.*'
     paths-ignore:
-      - "pom.xml"
       - "*.md"
     branches:
       - release/*
@@ -13,11 +13,14 @@ jobs:
     uses: ./.github/workflows/shared-build-and-deploy.yml
     with:
       ref: ${{ github.ref_name }}
-      is-internal: true
       server-id: central
       profile: jfrog
+      tag: 'internal'
     secrets:
       server-username: ${{ secrets.ARTIFACTORY_USERNAME }}
       server-password: ${{ secrets.ARTIFACTORY_PASSWORD }}
       gpg-key: ${{ secrets.JFROG_GPG_KEY }}
-      gpg-passphrase: ${{ secrets.JFROG_GPG_PASSPHRASE }}
+      gpg-passphrase: ${{ secrets.JFROG_GPG_PASSPHRASE }}
+      skyflow-credentials: ${{ secrets.SKYFLOW_CREDENTIALS }} >> .env
+      test-expired-token: ${{ secrets.TEST_EXPIRED_TOKEN }} >> .env
+      test-reusable-token: ${{ secrets.TEST_REUSABLE_TOKEN }} >> .env

.github/workflows/main.yml

@@ -13,7 +13,7 @@ jobs:
       - uses: actions/checkout@v1
       - uses: actions/setup-java@v1
         with:
-          java-version: '1.8'
+          java-version: '11'
 
       - name: create-json
         id: create-json
@@ -22,8 +22,16 @@ jobs:
           name: "credentials.json"
           json: ${{ secrets.TEST_CREDENTIALS_FILE_STRING }}
 
+      - name: create env
+        id: create-env
+        run: |
+          touch .env
+          echo SKYFLOW_CREDENTIALS=${{ secrets.SKYFLOW_CREDENTIALS }} >> .env
+          echo TEST_EXPIRED_TOKEN=${{ secrets.TEST_EXPIRED_TOKEN }} >> .env
+          echo TEST_REUSABLE_TOKEN=${{ secrets.TEST_REUSABLE_TOKEN }} >> .env
+
       - name: Build & Run tests with Maven
-        run: mvn -B package -DTEST_VAULT_ID=${{ secrets.TEST_VAULT_ID }} -DTEST_VAULT_URL=${{ secrets.TEST_VAULT_URL }} -DTEST_SKYFLOW_ID=${{ secrets.TEST_SKYFLOW_ID }} -DTEST_TOKEN=${{ secrets.TEST_TOKEN }} -DTEST_CREDENTIALS=${{ secrets.TEST_CREDENTIALS_FILE_STRING }} -DTEST_EXPIRED_TOKEN=${{ secrets.TEST_EXPIRED_TOKEN }} -f pom.xml
+        run: mvn -B package -f pom.xml -Dmaven.javadoc.skip=true
 
       - name: Codecov
         uses: codecov/codecov-action@v2.1.0

.github/workflows/pr.yml

@@ -1,6 +1,6 @@
 name: PR CI Checks
 
-on: [ pull_request ]
+on: [pull_request]
 
 jobs:
   check-commit-message:
@@ -11,18 +11,18 @@ jobs:
         uses: gsactions/commit-message-checker@v1
         with:
           pattern: '(\[?[A-Z]{1,5}-[1-9][0-9]*)|(\[AUTOMATED\])|(Merge)|(Release).+$'
-          flags: 'gm'
-          excludeDescription: 'true'
-          checkAllCommitMessages: 'true'
+          flags: "gm"
+          excludeDescription: "true"
+          checkAllCommitMessages: "true"
           accessToken: ${{ secrets.PAT_ACTIONS }}
-          error: 'One of your your commit messages is not matching the format with JIRA ID Ex: ( SDK-123 commit message )'
+          error: "One of your your commit messages is not matching the format with JIRA ID Ex: ( SDK-123 commit message )"
   Test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v1
       - uses: actions/setup-java@v1
         with:
-          java-version: '1.8'
+          java-version: "11"
 
       - name: create-json
         id: create-json
@@ -31,8 +31,16 @@ jobs:
           name: "credentials.json"
           json: ${{ secrets.TEST_CREDENTIALS_FILE_STRING }}
 
+      - name: create env
+        id: create-env
+        run: |
+          touch .env
+          echo SKYFLOW_CREDENTIALS=${{ secrets.SKYFLOW_CREDENTIALS }} >> .env
+          echo TEST_EXPIRED_TOKEN=${{ secrets.TEST_EXPIRED_TOKEN }} >> .env
+          echo TEST_REUSABLE_TOKEN=${{ secrets.TEST_REUSABLE_TOKEN }} >> .env
+
       - name: Build & Run tests with Maven
-        run: mvn -B package -DTEST_EXPIRED_TOKEN=${{ secrets.TEST_EXPIRED_TOKEN }} -DTEST_DATA_CREDENTIALS_FILE=${{ secrets.TEST_DATA_CREDENTIALS_FILE }} -f pom.xml
+        run: mvn -B package -f pom.xml -Dmaven.javadoc.skip=true
 
       - name: Codecov
         uses: codecov/codecov-action@v2.1.0
@@ -41,3 +49,15 @@ jobs:
           files: target/site/jacoco/jacoco.xml
           name: codecov-skyflow-java
           verbose: true
+
+  spellcheck:
+    name: Run spellcheck
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: streetsidesoftware/cspell-action@v8
+        with:
+          config: .cspell.json
+          strict: true
+          inline: error
+          incremental_files_only: false

.github/workflows/release.yml

@@ -1,17 +1,20 @@
-name: Publish package to the Maven Central Repository
+name: Public release
 on:
   push:
-    tags: '*.*.*'
+    tags: '[0-9]+.[0-9]+.[0-9]+'
 jobs:
   build-and-deploy:
     uses: ./.github/workflows/shared-build-and-deploy.yml
     with:
       ref: ${{ github.ref_name }}
-      is-internal: false
-      server-id: ossrh
+      server-id: central
       profile: maven-central
+      tag: 'public'
     secrets:
-      server-username: ${{ secrets.OSSRH_USERNAME }}
-      server-password: ${{ secrets.OSSRH_PASSWORD }}
+      server-username: ${{ secrets.CENTRAL_PUBLISHER_PORTAL_USERNAME }}
+      server-password: ${{ secrets.CENTRAL_PUBLISHER_PORTAL_PASSWORD }}
       gpg-key: ${{ secrets.MAVEN_GPG_PRIVATE_KEY }}
-      gpg-passphrase: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+      gpg-passphrase: ${{ secrets.MAVEN_GPG_PASSPHRASE }}
+      skyflow-credentials: ${{ secrets.SKYFLOW_CREDENTIALS }} >> .env
+      test-expired-token: ${{ secrets.TEST_EXPIRED_TOKEN }} >> .env
+      test-reusable-token: ${{ secrets.TEST_REUSABLE_TOKEN }} >> .env