Support for Dynamic MPTs (XLS-94D) #7841
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node | |
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions | |
name: Node.js CI | |
env: | |
RIPPLED_DOCKER_IMAGE: rippleci/rippled:develop | |
GIT_REF: ${{ inputs.git_ref || github.ref }} | |
on: | |
push: | |
branches: [main] | |
tags: | |
- '**' | |
pull_request: | |
workflow_dispatch: | |
workflow_call: | |
inputs: | |
git_ref: | |
description: 'Git ref to checkout (branch, tag, or commit SHA)' | |
required: true | |
type: string | |
jobs: | |
build-and-lint: | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
strategy: | |
matrix: | |
node-version: [24.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 | |
- run: npm run lint | |
unit: | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
strategy: | |
matrix: | |
node-version: [20.x, 22.x, 24.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 | |
- run: npm test | |
integration: | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
strategy: | |
matrix: | |
node-version: [20.x, 22.x, 24.x] | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
ref: ${{ env.GIT_REF }} | |
fetch-depth: 0 | |
- name: Run docker in background | |
id: run-docker | |
run: | | |
docker run --detach --rm -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/etc/opt/ripple/" --name rippled-service --health-cmd="rippled server_info || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true --entrypoint bash ${{ env.RIPPLED_DOCKER_IMAGE }} -c "rippled -a" | |
CONTAINER_ID=$(docker ps -aqf "name=rippled-service") | |
echo "docker-container-id=$CONTAINER_ID" >> $GITHUB_OUTPUT | |
- 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: Check if Docker container is running | |
id: check-docker-container | |
run: | | |
if ! docker ps | grep -q rippled-service; then | |
echo "INFO: Currently running docker containers:" | |
docker ps | |
echo "ERROR: rippled-service Docker container is not running" | |
exit 1 | |
fi | |
docker inspect ${{ steps.run-docker.outputs.docker-container-id }} | |
- name: Run integration test | |
run: npm run test:integration | |
- name: Stop docker container | |
if: always() | |
run: docker stop rippled-service | |
browser: | |
runs-on: ubuntu-latest | |
timeout-minutes: 10 | |
strategy: | |
matrix: | |
node-version: [24.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: Run docker in background | |
id: run-docker | |
run: | | |
docker run --detach --rm -p 6006:6006 --volume "${{ github.workspace }}/.ci-config/":"/etc/opt/ripple/" --name rippled-service --health-cmd="rippled server_info || exit 1" --health-interval=5s --health-retries=10 --health-timeout=2s --env GITHUB_ACTIONS=true --env CI=true --entrypoint bash ${{ env.RIPPLED_DOCKER_IMAGE }} -c "rippled -a" | |
CONTAINER_ID=$(docker ps -aqf "name=rippled-service") | |
echo "docker-container-id=$CONTAINER_ID" >> $GITHUB_OUTPUT | |
- 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: Check if Docker container is running | |
id: check-docker-container | |
run: | | |
if ! docker ps | grep -q rippled-service; then | |
echo "INFO: Currently running docker containers:" | |
docker ps | |
echo "ERROR: rippled-service Docker container is not running" | |
exit 1 | |
fi | |
docker inspect ${{ steps.run-docker.outputs.docker-container-id }} | |
- name: Run integration test | |
run: npm run test:browser | |
- name: Stop docker container | |
if: always() | |
run: docker stop rippled-service | |
generate-documentation: | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
node-version: [24.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 |