File tree Expand file tree Collapse file tree 4 files changed +21
-10
lines changed
contrib/tools/config-docs-generator Expand file tree Collapse file tree 4 files changed +21
-10
lines changed Original file line number Diff line number Diff line change @@ -32,6 +32,15 @@ concurrency:
32
32
run-name : ${{ github.ref_name }}
33
33
34
34
jobs :
35
+ # # Generate and upload node configuration documentation
36
+ node-config-docsgen :
37
+ name : Node Configuration Documentation
38
+ runs-on : ubuntu-latest
39
+ steps :
40
+ - name : Generate Node Configuration Documentation
41
+ id : node_config_docsgen
42
+ uses : stacks-network/actions/stacks-core/node-config-docsgen@feat/node-config-docsgen
43
+
35
44
# #
36
45
# # Jobs to execute everytime workflow runs
37
46
# # do not run if the trigger is any of the following:
93
102
needs :
94
103
- rustfmt
95
104
- check-release
96
- secrets : inherit
105
+ secrets : inherit
97
106
uses : ./.github/workflows/github-release.yml
98
107
with :
99
108
node_tag : ${{ needs.check-release.outputs.node_tag }}
Original file line number Diff line number Diff line change @@ -71,14 +71,14 @@ jobs:
71
71
validate : " true"
72
72
redocly-version : " 1.34"
73
73
74
- # # Generate and upload node configuration documentation
75
- node-config-docsgen :
76
- name : Node Configuration Documentation
77
- runs-on : ubuntu-latest
78
- steps :
79
- - name : Generate Node Configuration Documentation
80
- id : node_config_docsgen
81
- uses : stacks-network/actions/stacks-core/node-config-docsgen@feat/node-config-docsgen
74
+ # # # Generate and upload node configuration documentation
75
+ # node-config-docsgen:
76
+ # name: Node Configuration Documentation
77
+ # runs-on: ubuntu-latest
78
+ # steps:
79
+ # - name: Generate Node Configuration Documentation
80
+ # id: node_config_docsgen
81
+ # uses: stacks-network/actions/stacks-core/node-config-docsgen@feat/node-config-docsgen
82
82
83
83
# # Disabled
84
84
# # - this test can take several hours to run
@@ -150,7 +150,7 @@ jobs:
150
150
if : always()
151
151
needs :
152
152
- open-api-validation
153
- - node-config-docsgen
153
+ # - node-config-docsgen
154
154
- core-contracts-clarinet-test
155
155
steps :
156
156
- name : Check Tests Status
Original file line number Diff line number Diff line change @@ -72,6 +72,7 @@ main() {
72
72
# Step 2: Extract documentation from source code using rustdoc
73
73
log_info " Extracting configuration documentation using rustdoc..."
74
74
EXTRACTED_JSON=" $TEMP_DIR /extracted-config-docs.json"
75
+ log_info " Extracted JSON: $EXTRACTED_JSON "
75
76
76
77
# Determine the list of structs to document from section_name_mappings.json
77
78
# If the caller sets $TARGET_STRUCTS explicitly we honour that override.
Original file line number Diff line number Diff line change @@ -131,6 +131,7 @@ fn main() -> Result<()> {
131
131
// Extract configuration documentation from the rustdoc JSON
132
132
let config_docs = extract_config_docs_from_rustdoc ( & rustdoc_json, & target_structs) ?;
133
133
134
+ println ! ( "Writing extracted docs to: {output_file}" ) ;
134
135
// Write the extracted docs to file
135
136
fs:: write ( output_file, serde_json:: to_string_pretty ( & config_docs) ?) ?;
136
137
You can’t perform that action at this time.
0 commit comments