Skip to content

Conversation

@avivkeller
Copy link
Member

Fixes #8 by adding a CI script to generate all of the current generators, and upload their outputs as an artifact

Copilot AI review requested due to automatic review settings July 14, 2025 19:43
@avivkeller avivkeller requested a review from a team as a code owner July 14, 2025 19:43
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.1 inside the specified output folder
  • Introduced a GitHub Actions workflow (generate.yml) that runs the generate command 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 repository for clarity.
      - name: Git Checkout

@codecov
Copy link

codecov bot commented Jul 14, 2025

Codecov Report

Attention: Patch coverage is 90.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 72.14%. Comparing base (6fa7d1b) to head (e1857e6).
Report is 1 commits behind head on main.

✅ All tests successful. No failed tests found.

Files with missing lines Patch % Lines
src/generators/man-page/index.mjs 83.33% 1 Missing ⚠️
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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@avivkeller
Copy link
Member Author

You can download the artifacts from https://github.com/nodejs/api-docs-tooling/actions/runs/16276366515?pr=351

Copy link
Member

@ovflowd ovflowd left a comment

Choose a reason for hiding this comment

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

LGTM

@avivkeller avivkeller changed the title feat(ui): generate docs feat(ci): generate docs Jul 15, 2025
Copy link
Member

@AugustinMauroy AugustinMauroy left a comment

Choose a reason for hiding this comment

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

LGTM !

@avivkeller avivkeller merged commit 41ce248 into main Jul 15, 2025
17 checks passed
@avivkeller avivkeller deleted the feast/ci/8 branch July 15, 2025 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add GitHub Actions to test build and parsing pipelines

4 participants