Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Lock example values in auto-generated examples for RPC documentation #7756

Merged
merged 5 commits into from
Nov 26, 2024
Merged

Lock example values in auto-generated examples for RPC documentation #7756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
38fd22d
gitignore: cln-xpay plugin
ShahanaFarooqui Nov 26, 2024
7b0e7aa
doc: Lock example values
ShahanaFarooqui Aug 10, 2024
4ef1a07
doc: Lock askrene example values
ShahanaFarooqui Nov 26, 2024
3ccdbd9
make: Add check-doc-examples in Makefile for check-source
ShahanaFarooqui Oct 22, 2024
d31d4a3
doc: Updated section for Generating Examples in Schema
ShahanaFarooqui Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ jobs:
timeout-minutes: 30
env:
BOLTDIR: bolts
VALGRIND: 0
PYTEST_OPTS: --timeout=1200
strategy:
fail-fast: true
steps:
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ tests/node_pb2.py
tests/node_pb2_grpc.py
tests/primitives_pb2.py
tests/primitives_pb2_grpc.py
tests/autogenerate-examples-status.log
tests/autogenerate-examples.json

# Ignore unrelated stuff
.DS_Store
Expand Down
7 changes: 6 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -577,8 +577,13 @@ check-amount-access:
@! (git grep -nE "(->|\.)(milli)?satoshis" -- "*.c" "*.h" ":(exclude)common/amount.*" ":(exclude)*/test/*" | grep -v '/* Raw:')
@! git grep -nE "\\(struct amount_(m)?sat\\)" -- "*.c" "*.h" ":(exclude)common/amount.*" ":(exclude)*/test/*" | grep -vE "sizeof.struct amount_(m)?sat."

check-doc-examples:
$(PYTEST) $(PYTEST_OPTS) tests/autogenerate-rpc-examples.py
git diff --exit-code HEAD


# For those without working cppcheck
check-source-no-cppcheck: check-makefile check-source-bolt check-whitespace check-spelling check-python check-includes check-shellcheck check-setup_locale check-tmpctx check-discouraged-functions check-amount-access
check-source-no-cppcheck: check-makefile check-source-bolt check-whitespace check-spelling check-python check-includes check-shellcheck check-setup_locale check-tmpctx check-discouraged-functions check-amount-access check-doc-examples

check-source: check-source-no-cppcheck

Expand Down
Loading
Loading