Thanks to visit codestin.com
Credit goes to github.com

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 15 commits into from
Jul 29, 2025
Merged

feat: generate config docs on ci #6227

merged 15 commits into from
Jul 29, 2025

Conversation

@Jiloc
Copy link
Contributor

@Jiloc Jiloc commented Jun 25, 2025 •
edited
Loading

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.

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
@obycode obycode modified the milestones: 3.1.0.0.13, 3.1.0.0.14 Jul 1, 2025
@Jiloc Jiloc mentioned this pull request Jul 8, 2025
Merged
@Jiloc Jiloc modified the milestones: 3.2.0.0.0, 3.2.0.0.1 Jul 24, 2025
@kantai kantai moved this from Status: In Review to Status: 💻 In Progress in Stacks Core Eng Jul 24, 2025
@Jiloc Jiloc marked this pull request as ready for review July 28, 2025 15:15
@Jiloc Jiloc requested review from a team as code owners July 28, 2025 15:15
@Jiloc Jiloc requested a review from a team as a code owner July 28, 2025 15:15
@Jiloc Jiloc requested a review from fdefelici July 28, 2025 15:15
@Jiloc Jiloc moved this from Status: 💻 In Progress to Status: In Review in Stacks Core Eng Jul 28, 2025
wileyj
wileyj approved these changes Jul 28, 2025
View reviewed changes
Copy link
Collaborator

@wileyj wileyj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shipit

fdefelici
fdefelici approved these changes Jul 29, 2025
View reviewed changes
Copy link
Contributor

@fdefelici fdefelici left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@github-project-automation github-project-automation bot moved this from Status: In Review to Status: 💻 In Progress in Stacks Core Eng Jul 29, 2025
@wileyj wileyj added this pull request to the merge queue Jul 29, 2025
Merged via the queue into stacks-network:develop with commit 8f3ccbc Jul 29, 2025
1 of 2 checks passed
@github-project-automation github-project-automation bot moved this from Status: 💻 In Progress to Status: ✅ Done in Stacks Core Eng Jul 29, 2025
@codecov
Copy link

codecov bot commented Jul 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.90%. Comparing base (6168284) to head (36a9e41).
⚠️ Report is 34 commits behind head on develop.

❌ Your project status has failed because the head coverage (76.90%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage.

Additional details and impacted files 
@@             Coverage Diff             @@
##           develop    #6227      +/-   ##
===========================================
- Coverage    81.45%   76.90%   -4.56%     
===========================================
  Files          540      541       +1     
  Lines       347695   347771      +76     
===========================================
- Hits        283225   267459   -15766     
- Misses       64470    80312   +15842

see 225 files with indirect coverage changes

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6168284...36a9e41. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions
Copy link

github-actions bot commented Aug 6, 2025

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot added the locked label Aug 6, 2025
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@wileyj wileyj wileyj approved these changes

+1 more reviewer

@fdefelici fdefelici fdefelici approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@Jiloc Jiloc

Labels

locked

Projects

Stacks Core Eng
Status: Status: ✅ Done

Milestone

3.2.0.0.1

Development

Successfully merging this pull request may close these issues.

4 participants

@Jiloc @wileyj @fdefelici @obycode