-
-
Notifications
You must be signed in to change notification settings - Fork 6.4k
feat(ci): request reviews from API experts #8040
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
base: main
Are you sure you want to change the base?
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8040 +/- ##
==========================================
+ Coverage 76.59% 76.60% +0.01%
==========================================
Files 115 115
Lines 9602 9602
Branches 322 322
==========================================
+ Hits 7355 7356 +1
+ Misses 2246 2245 -1
Partials 1 1 ☔ View full report in Codecov by Sentry. |
38b5ff3 to
d43388a
Compare
|
Requesting a review from the following teams:
|
There was a problem hiding this 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 implements a new automated reviewer assignment system for Node.js documentation by mapping articles to API domains and their respective expert teams. The change replaces static CODEOWNERS assignments with dynamic review requests based on frontmatter metadata.
- Adds
apifrontmatter field to 51 learning documentation files to categorize content by Node.js API domain - Creates automated GitHub workflow to request reviews from appropriate API expert teams
- Removes static CODEOWNERS entries for TypeScript and security content in favor of the new dynamic system
Reviewed Changes
Copilot reviewed 54 out of 54 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Multiple learn/*.md files | Added api frontmatter field to categorize content by Node.js API domain |
| .github/workflows/request-review.yml | New workflow to automatically request reviews based on API categorization |
| .github/scripts/get-reviewers.mjs | Script to parse frontmatter and map APIs to reviewer teams |
| .github/reviewers.json | Configuration mapping API domains to GitHub teams |
| .github/CODEOWNERS | Removed static assignments for TypeScript and security content |
Comments suppressed due to low confidence (1)
.github/scripts/get-reviewers.mjs:40
- [nitpick] The parameter name 'content' is too generic. Consider renaming it to 'fileContent' or 'markdownContent' to better indicate what it contains.
if (!content.trimStart().startsWith('---')) {
ad6bbae to
f1b6706
Compare
apps/site/pages/en/learn/asynchronous-work/event-loop-timers-and-nexttick.md
Outdated
Show resolved
Hide resolved
|
Lighthouse Results
|
|
As discussed in the first Node.js Web Team Meeting, this PR now follows the |
|
@bmuenzenmeyer Can you please add my action to the allowlist (or I can move it into the organization, but that seems unnecessary for such a small action), so I can dummy-test it before merging this? |
|
Will do tomorrow |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have discussed it many times in some attempts to introduce actions hosted by personal accounts on nodejs/node, and the same applies on nodejs.org. I don't think we should use an action hosted outside of the Node.js organization as it introduces security risks (and opens a precedent)
Refs:
|
@bjohansebas Can you ask if @pkgjs will accept the action? |
|
(Also, for the record, this isn't the only case of outisde actions being used) |
Couldn't we host the action ourselves? |
|
I don’t have a strong opinion on whether it should stay here or be moved to pkgjs, and so far no one from the package-maintenance team has objected to transferring it to pkgjs (we’re still waiting for Aviv to go through the nomination, which should be soon, and then he could go ahead and make the transfer). |
|
The action is now in pkgjs (https://github.com/pkgjs/request-codeowner-review) |
|
Yup! I'll change this to use the new location tomorrow :-) |
Signed-off-by: Aviv Keller <[email protected]>
dcc651f to
713fac0
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
Is there still any objection? |
|
Bump @RafaelGSS |
|
Also, can someone confirm that |
Description
This is a potential solution for the linked issues, via mapping article -> api -> owner.
Prereqs:
@nodejs/typescriptwrite access revoked@nodejs/security-wgwrite access revoked1Validation
See #8040 (comment). In a real PR, these teams will be pinged.
Related Issues
Fixes #7292
Fixes #7294
Footnotes
Unless they have it for a different reason ↩