Skip to content

Commit 68c8bbd

Browse files
mvadariCopilotTapanito
authored
add template checker to CI (#419)
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Vito Tumas <5780819+Tapanito@users.noreply.github.com>
1 parent dd47baf commit 68c8bbd

File tree

85 files changed

+832
-153
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

85 files changed

+832
-153
lines changed

‎.github/workflows/deploy.yml‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,17 +32,17 @@ jobs:
3232
id: cache-deps
3333
with:
3434
path: ~/.cache/pip
35-
key: ${{ runner.os }}-pip-${{ hashFiles('**/site/requirements.txt') }}
35+
key: ${{ runner.os }}-pip-${{ hashFiles('**/scripts/requirements.txt') }}
3636
restore-keys: |
3737
${{ runner.os }}-pip-
3838
3939
- name: Install dependencies
4040
run: |
4141
python -m pip install --upgrade pip
42-
pip install -r site/requirements.txt
42+
pip install -r scripts/requirements.txt
4343
4444
- name: Build site
45-
run: python site/build_site.py
45+
run: python scripts/build_site.py
4646
env:
4747
GITHUB_PAGES_BASE_URL: ""
4848

@@ -52,7 +52,7 @@ jobs:
5252
- name: Upload artifact
5353
uses: actions/upload-pages-artifact@v4
5454
with:
55-
path: "site/_site"
55+
path: "scripts/_site"
5656

5757
deploy:
5858
if: github.repository == 'XRPLF/XRPL-Standards'

‎.github/workflows/validate-xls.yml‎

Lines changed: 59 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,79 @@ jobs:
2525
uses: actions/cache@v5
2626
with:
2727
path: ~/.cache/pip
28-
key: ${{ runner.os }}-pip-${{ hashFiles('**/site/requirements.txt') }}
28+
key: ${{ runner.os }}-pip-${{ hashFiles('**/scripts/requirements.txt') }}
2929
restore-keys: |
3030
${{ runner.os }}-pip-
3131
3232
- name: Install dependencies
3333
run: |
3434
python -m pip install --upgrade pip
35-
pip install -r site/requirements.txt
35+
pip install -r scripts/requirements.txt
3636
3737
- name: Validate XLS document parsing
3838
run: |
3939
echo "Running XLS document validation..."
40-
python site/xls_parser.py
40+
python scripts/xls_parser.py
4141
4242
- name: Report validation results
4343
if: always()
4444
run: |
4545
echo "XLS validation completed"
4646
echo "This pipeline validates that all XLS documents can be parsed correctly"
4747
echo "If this fails, it indicates issues with XLS document formatting or metadata"
48+
49+
validate-xls-template:
50+
runs-on: ubuntu-latest
51+
name: "[Beta CI Check] Validate XLS Template Compliance"
52+
53+
steps:
54+
- name: Checkout repository
55+
uses: actions/checkout@v6
56+
with:
57+
fetch-depth: 0 # Fetch full history for git diff
58+
59+
- name: Setup Python
60+
uses: actions/setup-python@v6
61+
with:
62+
python-version: "3.11"
63+
64+
- name: Cache Python dependencies
65+
id: cache-deps
66+
uses: actions/cache@v5
67+
with:
68+
path: ~/.cache/pip
69+
key: ${{ runner.os }}-pip-${{ hashFiles('**/scripts/requirements.txt') }}
70+
restore-keys: |
71+
${{ runner.os }}-pip-
72+
73+
- name: Install dependencies
74+
run: |
75+
python -m pip install --upgrade pip
76+
pip install -r scripts/requirements.txt
77+
78+
- name: Get changed XLS files
79+
id: changed-files
80+
uses: tj-actions/changed-files@v45
81+
with:
82+
files: |
83+
XLS-*/README.md
84+
85+
- name: Validate XLS template compliance
86+
if: steps.changed-files.outputs.all_changed_files != ''
87+
run: |
88+
echo "Running XLS template validation..."
89+
python scripts/validate_xls_template.py ${{ steps.changed-files.outputs.all_changed_files }}
90+
91+
- name: Report validation results
92+
if: always()
93+
run: |
94+
if [ "${{ steps.changed-files.outputs.all_changed_files }}" = "" ]; then
95+
echo "No XLS files were changed - skipping validation"
96+
else
97+
echo "XLS template validation completed"
98+
echo "Changed files: ${{ steps.changed-files.outputs.all_changed_files }}"
99+
echo ""
100+
echo "This validates that XLSes follow XLS_TEMPLATE.md"
101+
echo "And that Amendment specs follow AMENDMENT_TEMPLATE.md"
102+
echo "If this fails, check the error messages for missing sections or placeholders"
103+
fi

‎XLS-0001-xls-process/README.md‎

Lines changed: 69 additions & 68 deletions
Large diffs are not rendered by default.

‎XLS-0002-destination-information/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
title: XRPL destination information
44
description: A standard for encoding destination information with backwards compatibility for web browsers
55
author: Wietse Wind <w@xrpl-labs.com>
6-
discussion-from: https://github.com/XRPLF/XRPL-Standards/discussions/27
6+
proposal-from: https://github.com/XRPLF/XRPL-Standards/discussions/27
77
status: Stagnant
88
category: Ecosystem
99
created: 2019-02-25

‎XLS-0003-deeplink-signed-transactions/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
title: Sharing and deeplinking signed transactions
44
description: A standard for encoding HEX signed transactions for air-gapped submissions with deep link support
55
author: Wietse Wind <w@xrpl-labs.com>
6-
discussion-from: https://github.com/XRPLF/XRPL-Standards/discussions/26
6+
proposal-from: https://github.com/XRPLF/XRPL-Standards/discussions/26
77
status: Stagnant
88
category: Ecosystem
99
created: 2019-02-25

‎XLS-0004-trustline-uri/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
title: Trustline Add URI
44
description: A URI standard for instructing wallets to add trustlines following the design of XLS-2d
55
author: Richard Holland (@RichardAH)
6-
discussion-from: https://github.com/XRPLF/XRPL-Standards/discussions/25
6+
proposal-from: https://github.com/XRPLF/XRPL-Standards/discussions/25
77
status: Stagnant
88
category: Ecosystem
99
created: 2019-03-06

‎XLS-0005-tagged-addresses/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
title: Tagged Addresses
44
description: A standard for addresses that contain both the target wallet and destination tag as a single unit
55
author: Nikolaos D. Bougalis <nikb@bougalis.net>
6-
discussion-from: https://github.com/XRPLF/XRPL-Standards/discussions/142
6+
proposal-from: https://github.com/XRPLF/XRPL-Standards/discussions/142
77
status: Final
88
category: Ecosystem
99
created: 2019-06-04

‎XLS-0006-visual-account-icons/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
title: Standard for Visual Account Icons
44
description: A standard for visually distinguishing XRPL accounts by generating unique icons for each account, regardless of address format.
55
author: Richard Holland (@RichardAH)
6-
discussion-from: https://github.com/XRPLF/XRPL-Standards/discussions/24
6+
proposal-from: https://github.com/XRPLF/XRPL-Standards/discussions/24
77
status: Final
88
category: Ecosystem
99
created: 2019-09-22

‎XLS-0007-deletable-accounts/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
title: Deletable Accounts
44
description: A feature for completely removing accounts from the ledger and recovering the reserve from those accounts
55
author: Scott Schurr <scott@ripple.com>, Nik Bougalis <nikb@bougalis.net>
6-
discussion-from: https://github.com/XRPLF/XRPL-Standards/discussions/8
6+
proposal-from: https://github.com/XRPLF/XRPL-Standards/discussions/8
77
status: Final
88
category: Amendment
99
created: 2019-10-01

‎XLS-0008-tickets/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
description: Supporting out-of-sequence transactions on the XRP Ledger
55
author: Scott Schurr <scott@ripple.com>, Nik Bougalis (@nbougalis)
66
created: 2020-03-01
7+
proposal-from: https://github.com/XRPLF/XRPL-Standards/discussions/23
78
status: Withdrawn
89
category: Amendment
910
</pre>

0 commit comments

Comments
 (0)