Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds a CI workflow for generating documentation artifacts and adjusts the man-page generator to output its files into a directory.
- Changed the man-page generator to write its output as
node.1inside the specified output folder - Introduced a GitHub Actions workflow (
generate.yml) that runs thegeneratecommand for multiple targets and uploads each result as an artifact
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/generators/man-page/index.mjs | Updated writeFile target to join(options.output, 'node.1') |
| .github/workflows/generate.yml | New workflow to generate docs for various targets and upload artifacts |
Comments suppressed due to low confidence (2)
.github/workflows/generate.yml:84
- The upload-artifact step references
${{ matrix.output }}, which isn't defined. You likely meant to use the output directory (e.g.,out/${{ matrix.target }}) so the generated files are actually uploaded.
path: ${{ matrix.output }}
.github/workflows/generate.yml:52
- [nitpick] This step name is duplicated from the previous checkout. Consider renaming it to something like
Checkout Node.js repositoryfor clarity.
- name: Git Checkout
Codecov ReportAttention: Patch coverage is
✅ All tests successful. No failed tests found.
Additional details and impacted files@@ Coverage Diff @@
## main #351 +/- ##
==========================================
+ Coverage 72.12% 72.14% +0.02%
==========================================
Files 117 117
Lines 9984 9992 +8
Branches 597 597
==========================================
+ Hits 7201 7209 +8
Misses 2780 2780
Partials 3 3 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
You can download the artifacts from https://github.com/nodejs/api-docs-tooling/actions/runs/16276366515?pr=351 |
Fixes #8 by adding a CI script to generate all of the current generators, and upload their outputs as an artifact