Skip to content

Commit 9da6487

Browse files
ShahanaFarooquirustyrussell
authored andcommitted
github: Remove prefix from docs and actions
Changelog-Changed: Removed lightning- prefix from schemas/.json and doc/.md files.
1 parent bf3783c commit 9da6487

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

.github/workflows/readme-rpc-sync.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
branches:
66
- 'master'
77
paths:
8-
- 'doc/schemas/lightning-*.json'
8+
- 'doc/schemas/*.json'
99
- 'doc/*.1.md'
1010
- 'doc/*.5.md'
1111
- 'doc/*.8.md'

doc/contribute-to-core-lightning/coding-style-guidelines/writing-json-schemas.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ Similarly, if you deprecate a field, add "deprecated": "VERSION" (where VERSION
1717

1818
## How to Write a Schema
1919

20-
Name the schema doc/schemas/lightning-`command`.json: the testsuite should pick it up and check all invocations of that command against it.
20+
Name the schema doc/schemas/`command`.json: the testsuite should pick it up and check all invocations of that command against it.
2121
The core lightning RPC commands use custom schema specification defined in [rpc-schema-draft](https://github.com/ElementsProject/lightning/doc/rpc-schema-draft.json).
2222

23-
I recommend copying an existing one to start. If something goes wrong, try tools/fromscheme.py doc/schemas/lightning-`command`.json to see how far it got before it died.
23+
I recommend copying an existing one to start. If something goes wrong, try tools/fromscheme.py doc/schemas/`command`.json to see how far it got before it died.
2424

2525
You should always list all fields which are _always_ present in `"required"`.
2626

@@ -64,7 +64,7 @@ To add conditional fields:
6464

6565
## Generating Examples in Schema
6666
The `tests/autogenerate-rpc-examples.py` test script regenerates RPC examples for methods defined
67-
in `doc/schemas/lightning-*.json`, if the environment variable `GENERATE_EXAMPLES` is set to 1.
67+
in `doc/schemas/*.json`, if the environment variable `GENERATE_EXAMPLES` is set to 1.
6868
These examples are located at the end of each schema page, detailing `shell` and `json` request
6969
formats along with their corresponding `json` responses. The script utilizes the pytest suite to
7070
automate this task by running a test, `test_generate_examples`, that sets up test nodes, records

0 commit comments

Comments
 (0)