Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
158 commits
Select commit Hold shift + click to select a range
663b80f
chore: remove code rabbit sequence diagram (#2827)
justinr1234 Nov 14, 2024
3a604ce
build(deps-dev): bump @types/lodash from 4.17.12 to 4.17.13 (#2819)
dependabot[bot] Nov 15, 2024
a6852dd
build(deps-dev): bump @types/jest from 29.5.12 to 29.5.14 (#2821)
dependabot[bot] Nov 15, 2024
c920733
build(deps-dev): bump typedoc from 0.26.10 to 0.26.11 (#2822)
dependabot[bot] Nov 15, 2024
c2dd2ed
Update custom Payment to a higher number in binary codec test (#2824)
shawnxie999 Nov 18, 2024
24e9ad7
build(deps-dev): bump webpack from 5.95.0 to 5.96.1 (#2833)
dependabot[bot] Nov 21, 2024
b3a76bd
Update HISTORY.md (#2777)
dangell7 Dec 2, 2024
0061475
docs: update references in `CONTRIBUTING.md` (#2832)
emmanuel-ferdman Dec 4, 2024
f4011b5
build(deps): bump @scure/bip39 from 1.4.0 to 1.5.0 (#2838)
dependabot[bot] Dec 9, 2024
e3188b8
build(deps): bump @noble/hashes from 1.5.0 to 1.6.1 (#2837)
dependabot[bot] Dec 9, 2024
b04efe8
MPT (#2661)
shawnxie999 Dec 11, 2024
b7dfcbf
build(deps-dev): bump react from 18.3.1 to 19.0.0 (#2843)
dependabot[bot] Dec 11, 2024
305f2c4
build(deps): bump @noble/curves from 1.6.0 to 1.7.0 (#2836)
dependabot[bot] Dec 12, 2024
e42d418
feat: add node v22 and npm v10 support (#2695)
mvadari Dec 12, 2024
9f72c8d
build(deps): bump @scure/base from 1.1.9 to 1.2.1 (#2844)
dependabot[bot] Dec 12, 2024
448164d
chore: bump Github Actions versions (#2788)
mvadari Dec 13, 2024
303c2b9
build(deps): bump @scure/bip32 from 1.5.0 to 1.6.0 (#2852)
dependabot[bot] Dec 16, 2024
7bf6fec
add more mpt flag validations (#2856)
shawnxie999 Dec 19, 2024
f34d1a7
Credentials (#2829)
achowdhry-ripple Dec 20, 2024
11e7242
4.1.0 release (#2851)
khancode Dec 21, 2024
76c3355
build(deps-dev): bump webpack-cli from 5.1.4 to 6.0.1 (#2861)
dependabot[bot] Jan 2, 2025
7a2fa3f
build(deps-dev): bump webpack from 5.96.1 to 5.97.1 (#2853)
dependabot[bot] Jan 2, 2025
d812680
build(deps-dev): bump typedoc from 0.26.11 to 0.27.6 (#2863)
dependabot[bot] Jan 2, 2025
84943ae
build(deps-dev): bump ts-jest from 29.2.2 to 29.2.5 (#2764)
dependabot[bot] Jan 2, 2025
abdb192
Fix: parseTransactionFlags unintentionally modifies transaction (#2825)
achowdhry-ripple Jan 16, 2025
23d26c8
support DynamicNFT (#2726)
yinyiqian1 Feb 3, 2025
991a1d2
Add more unit test for DynamicNFT (#2892)
yinyiqian1 Feb 5, 2025
ce5ca31
feat: add support for the simulate RPC (XLS-69d) (#2867)
mvadari Feb 7, 2025
189abc1
PermissionedDomain XLS-80d (#2874)
ckeshava Feb 7, 2025
61da4c5
build(deps-dev): bump @types/lodash from 4.17.13 to 4.17.15 (#2891)
dependabot[bot] Feb 10, 2025
ea9e3dc
Deep Freeze XLS-77d (#2873)
ckeshava Feb 11, 2025
35e40d9
feat: add AMMClawback support (#2893)
khancode Feb 12, 2025
5b16d0c
4.2.0 release (#2896)
khancode Feb 14, 2025
c0d6d25
build(deps): bump ws and @types/ws (#2749)
dependabot[bot] Feb 23, 2025
ef1df65
build(deps): bump @scure/bip39 from 1.5.0 to 1.5.4 (#2882)
dependabot[bot] Feb 24, 2025
b16dd98
build(deps): bump ws and @types/ws (#2908)
dependabot[bot] Feb 24, 2025
7c57f1b
build(deps): bump @noble/curves from 1.7.0 to 1.8.1 (#2881)
dependabot[bot] Feb 24, 2025
48aeefe
build(deps-dev): bump typedoc from 0.27.6 to 0.27.8 (#2907)
dependabot[bot] Feb 24, 2025
0a45c58
build(deps): bump @noble/hashes from 1.6.1 to 1.7.1 (#2883)
dependabot[bot] Feb 24, 2025
31c50e0
build(deps-dev): bump ts-loader from 9.5.1 to 9.5.2 (#2914)
dependabot[bot] Mar 4, 2025
9d55cb3
build(deps-dev): bump webpack from 5.97.1 to 5.98.0 (#2916)
dependabot[bot] Mar 4, 2025
8995e3d
Docgen issue fix (#2910)
Patel-Raj Mar 8, 2025
fd51d8a
build(deps): bump @scure/bip32 from 1.6.0 to 1.6.2 (#2925)
dependabot[bot] Mar 10, 2025
c68902d
build(deps-dev): bump typedoc from 0.27.8 to 0.27.9 (#2926)
dependabot[bot] Mar 10, 2025
c090b3b
dev: add definitions.json generation script (#2826)
mvadari Mar 18, 2025
c97bbab
chore: remove more mentions of elliptic (#2920)
mvadari Mar 18, 2025
39affb6
fix: update packages to resolve potential security issues (#2932)
khancode Mar 18, 2025
ea4f606
fix: add MPTAmount support in Issue model (#2919)
achowdhry-ripple Mar 19, 2025
7fe27f3
fix #2911: Update OracleSet transaction model, unit, integ tests (#2913)
ckeshava Mar 19, 2025
066e670
fix: add `hash` field to `TransactionStream` (#2939)
mvadari Mar 28, 2025
effe757
Support NFTokenMintOffer (#2875)
tequdev Apr 2, 2025
b58acbb
chore(docs): update `definitions.json` generation docs (#2947)
mvadari Apr 15, 2025
8bcd386
fix(rbc): throw error instead of throwing away unknown fields (#2927)
mvadari Apr 17, 2025
b4be409
Adjustments for fee voting (#2812)
pdp2121 Apr 17, 2025
9211ff6
fix: add `MPTCurrency` type (#2964)
khancode Apr 21, 2025
33c5904
bump to publish non compromised version (#2971)
ckniffen Apr 22, 2025
f3f4e44
build(deps): bump @noble/hashes from 1.7.1 to 1.8.0 (#2975)
dependabot[bot] Apr 28, 2025
7cab71b
build(deps-dev): bump chai from 4.4.1 to 4.5.0 (#2984)
dependabot[bot] May 19, 2025
eeb74f7
feat: add Account Permission Delegation (XLS-74d, XLS-75d) (#2981)
khancode May 20, 2025
6aaf4d6
fix: add pseudo transactions to NON_DELEGATABLE_TRANSACTIONS (#2990)
khancode May 21, 2025
33ee9ae
refactor: use `NetworkID` in faucet calculations (#2950)
mvadari Jun 2, 2025
361a6b5
build(deps-dev): bump typedoc from 0.27.9 to 0.28.5 (#2992)
dependabot[bot] Jun 2, 2025
392a203
build(deps-dev): bump @types/lodash from 4.17.15 to 4.17.17 (#2991)
dependabot[bot] Jun 2, 2025
a85a450
fix: update DelegateSet error to `tecNO_DELEGATE_PERMISSION` (#3001)
khancode Jun 5, 2025
ac1bac7
Add Github Actions step for generating docs (#2954)
ckeshava Jun 6, 2025
9a997c8
feat: add support for Batch amendment (#2801)
mvadari Jun 6, 2025
3c19700
4.3.0 release (#3006)
khancode Jun 9, 2025
c55c89f
build(deps-dev): bump karma from 6.4.3 to 6.4.4 (#2753)
dependabot[bot] Jun 13, 2025
ee37e6c
build(deps): bump @scure/bip39 from 1.5.4 to 1.6.0 (#3004)
dependabot[bot] Jun 13, 2025
27dc2b4
Fix AccountRoot ledger object (#3010)
Patel-Raj11 Jun 16, 2025
36aeace
build(deps-dev): bump react from 19.0.0 to 19.1.0 (#2968)
dependabot[bot] Jun 17, 2025
dca1569
upgrade ws dependency (#2940)
ckeshava Jun 17, 2025
ea64933
build(deps-dev): bump webpack from 5.98.0 to 5.99.9 (#3015)
dependabot[bot] Jun 17, 2025
53c00e7
fix: add conditional check for `PermissionValue` definition (#3018)
khancode Jun 18, 2025
2ed9395
ripple-binary-codec 2.4.1 patch release (#3019)
khancode Jun 18, 2025
0eb77a9
test: Separate faucet tests from local integration tests (#2985)
achaljhawar Jun 19, 2025
b915376
fix: make `submitAndWait` fail faster with `tem` errors (#2948)
mvadari Jul 3, 2025
5d729fb
refactor: improve typing of `validateRequiredField`, `validateOptiona…
mvadari Jul 3, 2025
85521bd
refactor: refactor model tests to use a helper function (#2965)
mvadari Jul 3, 2025
500a842
feat: add Single Asset Vault (XLS-65) (#3008)
khancode Jul 3, 2025
7f85e33
Avoid running faucet tests with unit tests (#3033)
mvadari Jul 7, 2025
b308843
generate correct xrpl-latest-min.js file name (#3034)
Patel-Raj11 Jul 7, 2025
a12cd02
fix: add missing `MPTAmount` type to `VaultDeposit` & `VaultWithdraw`…
khancode Jul 9, 2025
bc7fc4b
XLS 85d: Token Escrow (#3027)
ckeshava Jul 11, 2025
a504482
XLS-81D Permissioned DEX (#3032)
ckeshava Jul 16, 2025
2309d59
fix: filename weback.test.config.js (#3043)
tequdev Jul 17, 2025
e3b7efd
fix: allow `DeliverMax` in `Payment` transaction (#3044)
khancode Jul 17, 2025
06071a4
introduce hex validation for domainID in Payment, OfferCreate txn (#3…
ckeshava Jul 23, 2025
7799528
Add warnings for MPTokenMetadata - XLS-89d (#3041)
Patel-Raj11 Jul 24, 2025
e958705
release 4.4.0 (#3055)
ckeshava Jul 29, 2025
de28f40
remove snippets files (#3054)
ckeshava Aug 6, 2025
9f61549
feat(dev): add support for pulling definitions from Github (#3046)
mvadari Aug 19, 2025
5c816e4
Release pipeline (#3039)
shichengripple001 Aug 22, 2025
4326290
Fix node.js process termination due to delayed websocket error callba…
Patel-Raj11 Aug 28, 2025
3c471fb
release workflow fix - skip .github directory from being searched in …
Patel-Raj11 Sep 2, 2025
201e126
Release/xrpl@4.4.1 (#3071)
Patel-Raj11 Sep 4, 2025
32a128f
fix: improve Batch inner transaction typing (#3035)
mvadari Sep 4, 2025
0608433
Migrate ESLint to v9 and it's related plugins to their latest major v…
Patel-Raj11 Sep 12, 2025
2f0eaa3
build(deps-dev): bump eslint from 9.32.0 to 9.35.0 (#3078)
dependabot[bot] Sep 16, 2025
0649abe
build(deps-dev): bump ts-loader from 9.5.2 to 9.5.4 (#3077)
dependabot[bot] Sep 16, 2025
710849a
Release with trusted publisher (#3085)
shichengripple001 Sep 24, 2025
e3ba5a8
Release 4.4.2: release-xrpl-4.4.2 → main (#3093)
github-actions[bot] Sep 25, 2025
006ef0f
Fix serialization of Issue type when asset is MPT (#3090)
Patel-Raj11 Sep 29, 2025
ba23d95
update slack message and update step description (#3098)
shichengripple001 Oct 1, 2025
ef7a9d3
build(deps-dev): bump webpack from 5.101.0 to 5.102.0 (#3104)
dependabot[bot] Oct 6, 2025
290795b
Trigger from release branch (#3100)
shichengripple001 Oct 9, 2025
9e7b328
ci: support Node 24 (#3105)
mvadari Oct 10, 2025
e2ce10d
Fix: deploy documentation workflow (#3101)
ckeshava Oct 18, 2025
3e867b0
update slack message/add version tag for owsap project (#3110)
shichengripple001 Oct 22, 2025
30a48e3
feat: add batch transaction exports to public API (#3064)
nabe3m Oct 28, 2025
3fb9c94
Release 2.5.1: release-rbc-2.5.1 → main (#3125)
github-actions[bot] Oct 30, 2025
bd883bd
Add encodeMPTokenMetadata and decodeMPTokenMetadata utility functions…
Patel-Raj11 Oct 31, 2025
3f128b7
Fix failed integration tests due to the removal of amendments (#3128)
kuan121 Nov 6, 2025
cdd88df
Release 4.4.3: release-xrpl-4.4.3 → main (#3130)
github-actions[bot] Nov 12, 2025
37efcc1
build(deps-dev): bump js-yaml from 3.14.1 to 3.14.2 (#3132)
dependabot[bot] Nov 17, 2025
8abcf5a
chores: Set free-form CI inputs as env vars (#3133)
pdp2121 Nov 18, 2025
afd2a1e
chores: assorted fixes for `release.yaml` (#3134)
pdp2121 Nov 21, 2025
fef333f
update ripple-binary-codec to 2.5.1 (#3126)
Patel-Raj11 Dec 1, 2025
c8fc356
VoD minor bug fixes (#3137)
achowdhry-ripple Dec 3, 2025
3f74511
fix: better formatting handling in definitions script (#3123)
mvadari Dec 5, 2025
ae9ce04
fix: improve faucet error handling (#3118)
mvadari Dec 5, 2025
64fd762
test: make connections.test.ts run faster (#3113)
mvadari Dec 5, 2025
3d6754c
Change dependabot frequency to monthly (#3139)
Patel-Raj11 Dec 5, 2025
802406e
build(deps-dev): bump typedoc from 0.28.5 to 0.28.15 (#3147)
dependabot[bot] Dec 8, 2025
2f66036
Mark AssetsAvailable, AssetsTotal and LossUnrealized of Vault object …
kuan121 Dec 10, 2025
9a1651d
Add support for lending protocol xls-66d (#3138)
Patel-Raj11 Dec 12, 2025
77d2412
feat: export more helper functions (#3157)
mvadari Dec 16, 2025
cf49131
Release 2.6.0: release-rbc-2.6.0 → main (#3159)
github-actions[bot] Dec 16, 2025
94f2d3a
Release 4.5.0: release-xrpl-4.5.0 → main (#3161)
github-actions[bot] Dec 16, 2025
d6c89f9
build(deps-dev): bump expect from 29.7.0 to 30.2.0 (#3148)
dependabot[bot] Dec 17, 2025
cd6e76f
Upgrade lerna to v8 (#3156)
ckeshava Dec 17, 2025
4912f72
Set dependabot version update frequency to quarterly (#3169)
Patel-Raj11 Jan 6, 2026
945e51a
build(deps-dev): bump @eslint/js from 9.35.0 to 9.39.2 (#3170)
dependabot[bot] Jan 7, 2026
1a0d467
build(deps-dev): bump @types/lodash from 4.17.20 to 4.17.21 (#3178)
dependabot[bot] Jan 7, 2026
d9ba1b8
build(deps-dev): bump webpack from 5.102.0 to 5.104.1 (#3166)
dependabot[bot] Jan 7, 2026
9abd7f9
build(deps-dev): bump ts-jest from 29.4.1 to 29.4.6 (#3162)
dependabot[bot] Jan 8, 2026
e048ded
build(deps-dev): bump eslint-plugin-n from 17.21.3 to 17.23.1 (#3143)
dependabot[bot] Jan 9, 2026
7dcad1b
build(deps-dev): bump typescript-eslint from 8.39.0 to 8.52.0 (#3173)
dependabot[bot] Jan 9, 2026
28b481e
build(deps-dev): bump webpack-bundle-analyzer from 4.10.2 to 5.1.0 (#…
dependabot[bot] Jan 12, 2026
c7a0be4
build(deps): bump ws from 8.18.3 to 8.19.0 (#3172)
dependabot[bot] Jan 12, 2026
f2601a1
build(deps-dev): bump eslint from 9.35.0 to 9.39.2 (#3163)
dependabot[bot] Jan 12, 2026
8c8c667
build(deps-dev): bump jest-mock from 29.7.0 to 30.2.0 (#3174)
dependabot[bot] Jan 12, 2026
aab83c8
Beta release workflow (#3131)
shichengripple001 Jan 14, 2026
0aca598
Makes fundWallet method work with locally running faucet server (#3186)
Patel-Raj11 Jan 16, 2026
104d948
build(deps-dev): bump react from 19.1.1 to 19.2.3 (#3165)
dependabot[bot] Jan 22, 2026
91e6410
build(deps-dev): bump lodash from 4.17.21 to 4.17.23 (#3189)
dependabot[bot] Jan 22, 2026
dd453d8
build(deps): bump bignumber.js from 9.1.2 to 9.3.0 (#2988)
dependabot[bot] Jan 26, 2026
cffd3a4
Update linter dev-dependencies (#3192)
ckeshava Jan 26, 2026
4716780
Upgrade chai dev-dependency to v6.2.2 (#3193)
ckeshava Jan 27, 2026
b449a31
Fix STNumber serialization and add counterparty signing helper functi…
Patel-Raj11 Feb 4, 2026
0c89766
fix: add integer check for UInt types in binary codec (#3179)
mvadari Feb 4, 2026
b1e139a
Add missing field types to lending protocol related objects and suppo…
Patel-Raj11 Feb 12, 2026
0a20504
Release 2.7.0: release-rbc-2.7.0 → main (#3202)
github-actions[bot] Feb 12, 2026
318a970
Release 4.6.0: release-xrpl-4.6.0 → main (#3204)
github-actions[bot] Feb 13, 2026
be8d9a2
build(deps-dev): bump lerna from 8.2.4 to 9.0.3 (#3175)
dependabot[bot] Feb 17, 2026
ea2e4e7
build(deps-dev): bump prettier from 3.6.2 to 3.7.4 (#3150)
dependabot[bot] Feb 23, 2026
2d37049
build(deps): bump minimatch and lerna (#3218)
dependabot[bot] Mar 2, 2026
928be9a
chore: add joey wallet, and other missing wallets to applications doc…
interc0der Mar 3, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
46 changes: 32 additions & 14 deletions .ci-config/rippled.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -63,17 +63,9 @@ online_delete=256
[debug_logfile]
/var/log/rippled/debug.log

[sntp_servers]
time.windows.com
time.apple.com
time.nist.gov
pool.ntp.org
[network_id]
0

[ips]
r.ripple.com 51235

[validators_file]
validators.txt

[rpc_startup]
{ "command": "log_level", "severity": "info" }
Expand Down Expand Up @@ -109,7 +101,6 @@ validators.txt
# Devnet amendments as of June 28th, 2023
NegativeUNL
fixRemoveNFTokenAutoTrustLine
NonFungibleTokensV1
CheckCashMakesTrustLine
fixRmSmallIncreasedQOffers
fixSTAmountCanonicalize
Expand Down Expand Up @@ -152,10 +143,8 @@ fix1512
fix1373
MultiSign
Checks
NonFungibleTokensV1_1
# 1.10.0 Amendments
DisallowIncoming
fixNonFungibleTokensV1_2
fixTrustLinesToSelf
fixUniversalNumber
ImmediateOfferKilled
Expand All @@ -166,7 +155,6 @@ ExpandedSignerList
AMM
Clawback
fixReducedOffersV1
fixNFTokenRemint
# 2.0.0 Amendments
XChainBridge
DID
Expand All @@ -178,3 +166,33 @@ PriceOracle
fixEmptyDID
fixXChainRewardRounding
fixPreviousTxnID
fixAMMv1_1
# 2.3.0 Amendments
AMMClawback
Credentials
NFTokenMintOffer
MPTokensV1
fixAMMv1_2
fixNFTokenPageLinks
fixInnerObjTemplate2
fixEnforceNFTokenTrustline
fixReducedOffersV2
# 2.4.0 Amendments
DeepFreeze
DynamicNFT
PermissionedDomains
fixFrozenLPTokenTransfer
fixInvalidTxFlags
# 2.5.0 Amendments
Batch
PermissionedDEX
TokenEscrow
SingleAssetVault
LendingProtocol
PermissionDelegationV1_1

# This section can be used to simulate various FeeSettings scenarios for rippled node in standalone mode
[voting]
reference_fee = 200 # 200 drops
account_reserve = 20000000 # 20 XRP
owner_reserve = 5000000 # 5 XRP
2 changes: 2 additions & 0 deletions .coderabbit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ reviews:
review_status: true
# Generate walkthrough in a markdown collapsible section.
collapse_walkthrough: false
# Generate sequence diagrams in the walkthrough.
sequence_diagrams: false
# Abort the in-progress review if the pull request is closed or merged.
abort_on_close: true
auto_review:
Expand Down
4 changes: 2 additions & 2 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ updates:
- package-ecosystem: npm
directory: "/"
schedule:
interval: weekly
interval: quarterly
time: "15:00"
open-pull-requests-limit: 10
open-pull-requests-limit: 30
8 changes: 4 additions & 4 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,11 @@ jobs:

steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4

# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
uses: github/codeql-action/init@v3
with:
languages: ${{ matrix.language }}
# If you wish to specify custom queries, you can do so here or in a config file.
Expand All @@ -48,7 +48,7 @@ jobs:
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
uses: github/codeql-action/autobuild@v2
uses: github/codeql-action/autobuild@v3

# ℹ️ Command-line programs to run using the OS shell.
# 📚 https://git.io/JvXDl
Expand All @@ -62,4 +62,4 @@ jobs:
# make release

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@v2
uses: github/codeql-action/analyze@v3
66 changes: 66 additions & 0 deletions .github/workflows/faucet_test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: Faucet Tests

on:
push:
branches: [main]
workflow_dispatch:
workflow_call:
inputs:
git_ref:
description: 'Git ref to checkout (branch, tag, or commit SHA)'
required: true
type: string
run_faucet_tests:
description: 'Run faucet tests job'
required: false
type: boolean
default: true


jobs:
faucet-test:
if: ${{ github.event_name != 'workflow_dispatch' || inputs.run_faucet_tests != false }}
runs-on: ubuntu-latest
timeout-minutes: 15

strategy:
max-parallel: 1
matrix:
node-version: [18.x]

steps:
- uses: actions/checkout@v4
with:
ref: ${{ inputs.git_ref || github.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:
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

- name: Build
run: npm run build

- name: Run Faucet Tests
run: npm run test:faucet
77 changes: 77 additions & 0 deletions .github/workflows/generate-documentation.yml
Original file line number Diff line number Diff line change
@@ -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
Loading