Skip to content

Commit 23860a9

Browse files
committed
add debugging logs. move workflow for faster iterations
1 parent 9bd106d commit 23860a9

File tree

4 files changed

+21
-10
lines changed

4 files changed

+21
-10
lines changed

.github/workflows/ci.yml

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,15 @@ concurrency:
3232
run-name: ${{ github.ref_name }}
3333

3434
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+
3544
##
3645
## Jobs to execute everytime workflow runs
3746
## do not run if the trigger is any of the following:
@@ -93,7 +102,7 @@ jobs:
93102
needs:
94103
- rustfmt
95104
- check-release
96-
secrets: inherit
105+
secrets: inherit
97106
uses: ./.github/workflows/github-release.yml
98107
with:
99108
node_tag: ${{ needs.check-release.outputs.node_tag }}

.github/workflows/stacks-core-tests.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,14 @@ jobs:
7171
validate: "true"
7272
redocly-version: "1.34"
7373

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
8282

8383
## Disabled
8484
## - this test can take several hours to run
@@ -150,7 +150,7 @@ jobs:
150150
if: always()
151151
needs:
152152
- open-api-validation
153-
- node-config-docsgen
153+
# - node-config-docsgen
154154
- core-contracts-clarinet-test
155155
steps:
156156
- name: Check Tests Status

contrib/tools/config-docs-generator/generate-config-docs.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ main() {
7272
# Step 2: Extract documentation from source code using rustdoc
7373
log_info "Extracting configuration documentation using rustdoc..."
7474
EXTRACTED_JSON="$TEMP_DIR/extracted-config-docs.json"
75+
log_info "Extracted JSON: $EXTRACTED_JSON"
7576

7677
# Determine the list of structs to document from section_name_mappings.json
7778
# If the caller sets $TARGET_STRUCTS explicitly we honour that override.

contrib/tools/config-docs-generator/src/extract_docs.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ fn main() -> Result<()> {
131131
// Extract configuration documentation from the rustdoc JSON
132132
let config_docs = extract_config_docs_from_rustdoc(&rustdoc_json, &target_structs)?;
133133

134+
println!("Writing extracted docs to: {output_file}");
134135
// Write the extracted docs to file
135136
fs::write(output_file, serde_json::to_string_pretty(&config_docs)?)?;
136137

0 commit comments

Comments
 (0)