Skip to content

Commit 3ba45fd

Browse files
committed
add to work with action
1 parent 110753b commit 3ba45fd

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

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

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ NC='\033[0m' # No Color
1212
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
1313
PROJECT_ROOT="${PROJECT_ROOT:-$(cd "$SCRIPT_DIR/../../../" && pwd)}"
1414
CARGO_TARGET_DIR="${CARGO_TARGET_DIR:-$PROJECT_ROOT/target}"
15-
OUTPUT_DIR="${OUTPUT_DIR:-$CARGO_TARGET_DIR/generated-docs}"
15+
OUTPUT_FILE="${OUTPUT_FILE:-$CARGO_TARGET_DIR/generated-docs/node-parameters.md}"
1616
TEMP_DIR="${TEMP_DIR:-$CARGO_TARGET_DIR/doc-generation}"
1717

1818
# Binary paths - allow override via environment
@@ -52,7 +52,7 @@ main() {
5252
log_info "Starting config documentation generation..."
5353

5454
# Create necessary directories
55-
mkdir -p "$OUTPUT_DIR"
55+
mkdir -p "$(dirname "$OUTPUT_FILE")"
5656
mkdir -p "$TEMP_DIR"
5757

5858
cd "$PROJECT_ROOT"
@@ -81,22 +81,21 @@ main() {
8181

8282
# Step 3: Generate Markdown
8383
log_info "Generating Markdown documentation..."
84-
MARKDOWN_OUTPUT="$OUTPUT_DIR/configuration-reference.md"
8584

8685
# Call the command
87-
"$GENERATE_MARKDOWN_BIN" --input "$EXTRACTED_JSON" --output "$MARKDOWN_OUTPUT" --template "$TEMPLATE_PATH" --section-name-mappings "$SECTION_MAPPINGS_PATH"
86+
"$GENERATE_MARKDOWN_BIN" --input "$EXTRACTED_JSON" --output "$OUTPUT_FILE" --template "$TEMPLATE_PATH" --section-name-mappings "$SECTION_MAPPINGS_PATH"
8887

8988
log_info "Documentation generation complete!"
9089
log_info "Generated files:"
91-
log_info " - Configuration reference: $MARKDOWN_OUTPUT"
90+
log_info " - Configuration reference: $OUTPUT_FILE"
9291
log_info " - Intermediate JSON: $EXTRACTED_JSON"
9392

9493
# Verify output
95-
if [[ -f "$MARKDOWN_OUTPUT" ]]; then
96-
WORD_COUNT=$(wc -w < "$MARKDOWN_OUTPUT")
94+
if [[ -f "$OUTPUT_FILE" ]]; then
95+
WORD_COUNT=$(wc -w < "$OUTPUT_FILE")
9796
log_info "Generated Markdown contains $WORD_COUNT words"
9897
else
99-
log_error "Expected output file not found: $MARKDOWN_OUTPUT"
98+
log_error "Expected output file not found: $OUTPUT_FILE"
10099
exit 1
101100
fi
102101
}
@@ -125,7 +124,7 @@ DESCRIPTION:
125124
Source file: stackslib/src/config/mod.rs
126125
127126
OUTPUT:
128-
docs/generated/configuration-reference.md
127+
docs/generated/node-parameters.md
129128
130129
EOF
131130
}

0 commit comments

Comments
 (0)