Skip to content

feat: generate config docs on ci #6227

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.

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

Draft
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

Jiloc
Copy link
Contributor

@Jiloc Jiloc commented Jun 25, 2025

Description

Adds node-config-docsgen to the CI workflow to automatically create an artifact of the node documentation.
It also slightly modify contrib/tools/config-docs-generator/generate-config-docs.sh to have a configurable output used by the action.

In draft till the corresponding action PR will be merged stacks-network/actions#77

Applicable issues

Additional info (benefits, drawbacks, caveats)

Checklist

  • Test coverage for new or modified code paths
  • Changelog is updated
  • Required documentation changes (e.g., docs/rpc/openapi.yaml and rpc-endpoints.md for v2 endpoints, event-dispatcher.md for new events)
  • New clarity functions have corresponding PR in clarity-benchmarking repo
  • New integration test(s) added to bitcoin-tests.yml

@Jiloc Jiloc added this to the 3.1.0.0.13 milestone Jun 25, 2025
@Jiloc Jiloc requested a review from wileyj June 25, 2025 15:58
@Jiloc Jiloc self-assigned this Jun 25, 2025
@Jiloc Jiloc moved this to Status: 💻 In Progress in Stacks Core Eng Jun 25, 2025
@Jiloc Jiloc moved this from Status: 💻 In Progress to Status: In Review in Stacks Core Eng Jun 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Status: In Review
Development

Successfully merging this pull request may close these issues.

1 participant