Merge branch 'main' of github.com:XRPLF/xrpl.js into lending-protocol-xls-66d

Author: Patel-Raj11

.github/workflows/generate-documentation.yml

@@ -0,0 +1,77 @@
+name: Generate Documentation
+
+on:
+  workflow_call:
+    inputs:
+      git_ref:
+        description: 'Git ref to checkout (branch, tag, or commit SHA)'
+        required: true
+        type: string
+
+env:
+  GIT_REF: ${{ inputs.git_ref }}
+
+jobs:
+  generate-documentation:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [22.x]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ env.GIT_REF }}
+          fetch-depth: 0
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Setup npm version 10
+        run: |
+          npm i -g npm@10 --registry=https://registry.npmjs.org
+      - name: Cache node modules
+        id: cache-nodemodules
+        uses: actions/cache@v4
+        env:
+          cache-name: cache-node-modules
+        with:
+          # caching node_modules
+          path: |
+            node_modules
+            */*/node_modules
+          key: ${{ runner.os }}-deps-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-deps-${{ matrix.node-version }}-
+      - name: Install Dependencies
+        if: steps.cache-nodemodules.outputs.cache-hit != 'true'
+        run: npm ci
+
+      - run: npm run build
+
+      - name: Generate Documentation
+        run: npm run docgen
+
+      - name: Upload documentation files as artifact
+        id: docs-artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/
+          retention-days: 10
+
+  deploy-docs-pages:
+    permissions:
+      id-token: write  # Needed for OIDC authentication
+      pages: write # this permission is needed for deploying into Github Pages
+    environment:
+      name: github-pages
+      url: ${{ steps.docs-artifact.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: generate-documentation
+    steps:
+      - name: Deploy to Documentation to GitHub Pages
+        id: docs-artifact
+        uses: actions/deploy-pages@v4

.github/workflows/nodejs.yml

@@ -27,7 +27,7 @@ jobs:
     timeout-minutes: 10
     strategy:
       matrix:
-        node-version: [22.x]
+        node-version: [24.x]
 
     steps:
       - uses: actions/checkout@v4
@@ -70,7 +70,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [20.x, 22.x]
+        node-version: [20.x, 22.x, 24.x]
 
     steps:
       - uses: actions/checkout@v4
@@ -113,7 +113,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [20.x, 22.x]
+        node-version: [20.x, 22.x, 24.x]
 
     steps:
       - uses: actions/checkout@v4
@@ -167,7 +167,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [22.x]
+        node-version: [24.x]
 
     steps:
       - uses: actions/checkout@v4
@@ -214,79 +214,3 @@ jobs:
       - name: Stop docker container
         if: always()
         run: docker stop rippled-service
-
-  generate-documentation:
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [22.x]
-
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          ref: ${{ env.GIT_REF }}
-          fetch-depth: 0
-
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-
-      - name: Setup npm version 10
-        run: |
-          npm i -g npm@10 --registry=https://registry.npmjs.org
-
-      - name: Cache node modules
-        id: cache-nodemodules
-        uses: actions/cache@v4
-        env:
-          cache-name: cache-node-modules
-        with:
-          # caching node_modules
-          path: |
-            node_modules
-            */*/node_modules
-          key: ${{ runner.os }}-deps-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
-          restore-keys: |
-            ${{ runner.os }}-deps-${{ matrix.node-version }}-
-
-      - name: Install Dependencies
-        if: steps.cache-nodemodules.outputs.cache-hit != 'true'
-        run: npm ci
-
-      - run: npm run build
-
-      - name: Generate Documentation
-        run: npm run docgen
-
-      - name: Upload documentation files as artifact
-        id: docs-artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: docs/
-          retention-days: 10
-
-  deploy-docs-pages:
-    permissions:
-      id-token: write  # Needed for OIDC authentication
-      pages: write # this permission is needed for deploying into Github Pages
-    environment:
-      name: github-pages
-      url: ${{ steps.docs-artifact.outputs.page_url }}
-    runs-on: ubuntu-latest
-    needs: generate-documentation
-    # Deploy docs only pushes into the main branch
-    if: success() && github.ref == 'refs/heads/main'
-    steps:
-      - name: Detect (non-beta) version tag
-        id: check-tag
-        run: |
-          if [[ ${{ github.event.ref }} =~ ^refs/tags/v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
-              echo "published_version_tag=true" >> $GITHUB_OUTPUT
-          fi
-
-      - name: Deploy to Documentation to GitHub Pages
-        id: docs-artifact
-        if: steps.check-tag.outputs.published_version_tag == 'true'
-        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -9,9 +9,6 @@ on:
       package_name:
         description: 'Package folder (Name of the package directory under packages/ folder. e.g., xrpl, ripple-address-codec)'
         required: true
-      release_branch:
-        description: 'Release branch the release is generated from'
-        required: true
       npmjs_dist_tag:
         description: 'npm distribution tag(Read more https://docs.npmjs.com/adding-dist-tags-to-packages)'
         default: 'latest'
@@ -30,12 +27,21 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          ref: ${{ github.event.inputs.release_branch }}
           fetch-depth: 0
 
       - name: Validate inputs
         run: |
           set -euo pipefail
+          RELEASE_BRANCH="$(git branch --show-current || true)"
+          if [[ -z "$RELEASE_BRANCH" ]]; then
+            RELEASE_BRANCH="${{ github.ref_name }}"
+          fi
+
+          if [[ -z "$RELEASE_BRANCH" ]]; then
+            echo "❌ Unable to determine branch name." >&2
+            exit 1
+          fi
+
           # Validate package_name
           PKG_NAME="${{ github.event.inputs.package_name }}"
           if ! [[ "$PKG_NAME" =~ ^[a-z0-9][a-z0-9-]*$ ]]; then
@@ -47,10 +53,9 @@ jobs:
             echo "❌ package_name must be a single directory under packages/." >&2
             exit 1
           fi
-          if git ls-remote --exit-code origin "refs/heads/${{ github.event.inputs.release_branch }}" > /dev/null; then
-            echo "✅ Found release branch: ${{ github.event.inputs.release_branch }}"
-          else
-            echo "❌ Release branch ${{ github.event.inputs.release_branch }} not found in remote. Failing workflow."
+
+          if [[ ! "${RELEASE_BRANCH,,}" =~ ^release[-/] ]]; then
+            echo "❌ Release branch '$RELEASE_BRANCH' must start with 'release-' or 'release/'." >&2
             exit 1
           fi
 
@@ -115,7 +120,7 @@ jobs:
     needs: [get_version]
     uses: ./.github/workflows/faucet_test.yml
     with:
-      git_ref: ${{ github.event.inputs.release_branch }}
+      git_ref: ${{ github.ref }}
     secrets: inherit
 
   run_tests:
@@ -127,7 +132,7 @@ jobs:
     needs: [get_version]
     uses: ./.github/workflows/nodejs.yml
     with:
-      git_ref: ${{ github.event.inputs.release_branch }}
+      git_ref: ${{ github.ref }}
     secrets: inherit
 
   pre_release:
@@ -143,7 +148,6 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          ref: ${{ github.event.inputs.release_branch }}
           fetch-depth: 0
 
       - name: Set up Node.js
@@ -199,7 +203,9 @@ jobs:
         run: |
           curl -X POST \
             -H "X-Api-Key: ${{ secrets.OWASP_TOKEN }}" \
-            -F "project=7c40c8ea-ea0f-4a5f-9b9f-368e53232397" \
+            -F "autoCreate=true" \
+            -F "projectName=xrpl-js" \
+            -F "projectVersion=${{ env.PACKAGE_VERSION }}" \
             -F "[email protected]" \
             https://owasp-dt-api.prod.ripplex.io/api/v1/bom
 
@@ -245,7 +251,7 @@ jobs:
           REPO: ${{ github.repository }}
           PKG_NAME: ${{ env.PACKAGE_NAME }}
           PKG_VER: ${{ env.PACKAGE_VERSION }}
-          REL_BRANCH: ${{ github.event.inputs.release_branch }}
+          REL_BRANCH: ${{ github.ref_name }}
           VULN_ART_URL: ${{ steps.vuln_art.outputs.art_url }}
           LABELS: security
         run: |
@@ -294,10 +300,11 @@ jobs:
     needs: [get_version, run_faucet_test, run_tests, pre_release]
     permissions:
       pull-requests: write
-    name: Review test and security scan result -- Dev team
+    name: Print Test/Security scan result and invite Dev team to review
     env:
       PACKAGE_VERSION: "${{ needs.get_version.outputs.package_version }}"
       PACKAGE_NAME: "${{ github.event.inputs.package_name }}"
+      RELEASE_BRANCH: "${{ github.ref_name }}"
     outputs:
       reviewers_dev: ${{ steps.get_reviewers.outputs.reviewers_dev }}
       reviewers_sec: ${{ steps.get_reviewers.outputs.reviewers_sec }}
@@ -306,15 +313,14 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          ref: ${{ github.event.inputs.release_branch }}
           fetch-depth: 0
       - name: Create PR from release branch to main (skips for rc/beta)
         id: ensure_pr
         if: ${{ github.event.inputs.npmjs_dist_tag == '' || github.event.inputs.npmjs_dist_tag == 'latest' }}
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           REPO: ${{ github.repository }}
-          RELEASE_BRANCH: ${{ github.event.inputs.release_branch }}
+          RELEASE_BRANCH: ${{ github.ref_name }}
           VERSION: ${{ needs.get_version.outputs.package_version }}
         run: |
           set -euo pipefail
@@ -423,7 +429,6 @@ jobs:
         run: |
           set -euo pipefail
           ARTIFACT_NAME="vulnerability-report"
-          RELEASE_BRANCH="${{ github.event.inputs.release_branch }}"
           COMMIT_SHA="$(git rev-parse --short HEAD)"
 
           echo "Fetching artifact ID for ${ARTIFACT_NAME}..."
@@ -487,14 +492,13 @@ jobs:
   ask_for_sec_team_review:
     runs-on: ubuntu-latest
     needs: [get_version, run_faucet_test, run_tests, pre_release, ask_for_dev_team_review, first_review]
-    name: Review test and security scan result — Sec team
+    name: Invite sec team to review
     steps:
       - name: Send Sec team review request to Slack
         shell: bash
         env:
           SLACK_TOKEN:     ${{ secrets.SLACK_TOKEN }}
-          CHANNEL:         "#xrpl-js"
-
+          CHANNEL:         "#ripplex-security"
           EXECUTOR:        ${{ github.triggering_actor || github.actor }}
           PACKAGE_NAME:    ${{ needs.get_version.outputs.package_version && github.event.inputs.package_name }}
           PACKAGE_VERSION: ${{ needs.get_version.outputs.package_version }}
@@ -517,7 +521,7 @@ jobs:
       id-token: write
       contents: write
     needs: [get_version, run_faucet_test, run_tests, pre_release, ask_for_dev_team_review, first_review, ask_for_sec_team_review]
-    name: Release Pipeline for ${{ needs.get_version.outputs.package_version }}
+    name: Release for ${{ needs.get_version.outputs.package_version }}
     env:
       PACKAGE_VERSION: "${{ needs.get_version.outputs.package_version }}"
       PACKAGE_NAME: "${{ github.event.inputs.package_name }}"
@@ -534,7 +538,6 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v4
         with:
-          ref: ${{ github.event.inputs.release_branch }}
           fetch-depth: 0
 
       - name: Download artifact
@@ -622,11 +625,23 @@ jobs:
         env:
           SLACK_TOKEN: ${{ secrets.SLACK_TOKEN }}
         run: |
-          MESSAGE="❌ Tests failed for xrpl.js ${{ env.PACKAGE_VERSION }}. Check the logs: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
+          MESSAGE="❌ Release failed for ${{ env.PACKAGE_NAME }}@${{ env.PACKAGE_VERSION }}. Check the logs: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}"
           curl -X POST https://slack.com/api/chat.postMessage \
             -H "Authorization: Bearer $SLACK_TOKEN" \
             -H "Content-Type: application/json" \
             -d "$(jq -n \
                   --arg channel "#xrpl-js" \
                   --arg text "$MESSAGE" \
                   '{channel: $channel, text: $text}')"
+
+  generate-documentation:
+    name: Generate and Publish documentation for ${{ needs.get_version.outputs.package_version }}
+    if: ${{ github.event.inputs.npmjs_dist_tag == 'latest' }}
+    uses: ./.github/workflows/generate-documentation.yml
+    needs: [get_version, release]
+    with:
+      git_ref: ${{ github.ref_name }}
+    permissions:
+      contents: read
+      id-token: write
+      pages: write

CONTRIBUTING.md

@@ -241,7 +241,6 @@ Note: The same updated config can be used to update xrpl-py's CI as well.
 
    - [ ] Update the version number and release date, and ensure it lists the changes since the previous release.
 
-4. Run `npm run docgen` if the docs were modified in this release to update them (skip this step for a beta).
 5. Run `npm run clean` to delete previously generated artifacts.
 6. Run `npm run build` to triple check the build still works
 7. Run `npx lerna version --no-git-tag-version` - This bumps the package versions.
@@ -265,6 +264,7 @@ Note: The same updated config can be used to update xrpl-py's CI as well.
 
 13. Run `git tag <tagname> -m <tagname>`, where `<tagname>` is the new package and version (e.g. `[email protected]`), for each version released.
 14. Run `git push --follow-tags`, to push the tags to Github.
+
 15. On GitHub, click the "Releases" link on the right-hand side of the page.
 
 16. Repeat for each release: