cli: generate man-page #55885
Open
cli: generate man-page #55885
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
build
avivkeller
added
the
cli
Codecov ReportAll modified and coverable lines are covered by tests ✅
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 |
jasnell
approved these changes
Nov 23, 2024
ovflowd
reviewed
Jan 26, 2025
There was a problem hiding this comment.
Do we need the lint-md to run on our generated stuff?
|
cc @avivkeller can you rebase? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.1file to theformat-mdcommand. 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-toolingtool. Currently, it is locked to nodejs/api-docs-tooling@bbf44c4 to prevent any future changes from breaking this.