Skip to content
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

cli: generate man-page #55885

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

RedYetiDev
Copy link
Member

The tree of #55268 got messed up (sorry!), and I had to recreate.

CC @aduh95 @ovflowd (previous reviewers)


This PR adds generation of the node.1 file to the format-md command. This way, the manpage is always up-to-date with a new release, as it currently contains outdated (and/or incorrect) information.

This is done by using the @node-core/api-docs-tooling tool. Currently, it is locked to nodejs/api-docs-tooling@bbf44c4 to prevent any future changes from breaking this.

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory. labels Nov 16, 2024
@RedYetiDev RedYetiDev added the cli Issues and PRs related to the Node.js command line interface. label Nov 16, 2024
Copy link

codecov bot commented Nov 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.92%. Comparing base (b02cd41) to head (aa7ca6b).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #55885      +/-   ##
==========================================
- Coverage   88.42%   87.92%   -0.51%     
==========================================
  Files         654      654              
  Lines      187852   187852              
  Branches    36134    35830     -304     
==========================================
- Hits       166102   165162     -940     
- Misses      14989    15881     +892     
- Partials     6761     6809      +48     

see 97 files with indirect coverage changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Issues and PRs related to build files or the CI. cli Issues and PRs related to the Node.js command line interface. needs-ci PRs that need a full CI run. tools Issues and PRs related to the tools directory.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants