-
Notifications
You must be signed in to change notification settings - Fork 10
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
feat(semver-major): Upgrade package to Node.js v23 #54
Open
RedYetiDev
wants to merge
2
commits into
nodejs:main
Choose a base branch
from
RedYetiDev:v23
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,2 @@ | ||
|
||
test | ||
.github |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Package Maintenance Guide | ||
|
||
This guide provides a step-by-step approach to maintaining the package, ensuring its ongoing functionality and compatibility with newer Node.js versions. The aim is to simplify maintenance until the majority of users have transitioned to newer versions, ultimately leading to the package's deprecation. | ||
|
||
## Overview | ||
|
||
Maintaining this package involves updating specific internal files and adjusting references as needed. The steps below outline a structured process to ensure effective and consistent maintenance. | ||
|
||
## Steps for Maintenance | ||
|
||
### Identify Files to Update | ||
Begin by locating the internal files that need updating. These files are generally found in the `lib/internal/test_runner` directory. For example, `lib/internal/test_runner/runner.js` is a file that might require changes. | ||
|
||
### Update the File Contents | ||
- Replace the content of the identified file with the updated version from the appropriate reference source, ensuring you use the version that reflects recent changes in Node.js internals. | ||
|
||
- There may be cases where a slight modification of the file may be needed in order for it to work with this polyfill. Ideally, only the minimal amount should be modified, to make future updating as easy as possible. If contents *must* be altered, leave a comment `/* NOTE(Author): ... */` explaining the change. | ||
|
||
### Update `require` Statements | ||
- Once the file content is updated, search for any occurrences of: | ||
```javascript | ||
require('internal/...'); | ||
``` | ||
- Replace these instances with the updated syntax: | ||
```javascript | ||
require('#internal/...'); | ||
``` | ||
|
||
### Add Required Imports | ||
- If the updated file needs specific bindings, add the following line at the top: | ||
```javascript | ||
const { primordials, internalBinding } = require('#lib/bootstrap'); | ||
``` | ||
|
||
### Follow Special Comments | ||
- Pay attention to any comments in the format `/* NOTE(Author): ... */` within the code. These may provide important instructions or considerations. Make sure to follow any guidelines specified in these comments. | ||
|
||
### Implement Polyfills if Necessary | ||
- If new features require polyfills that are not already available, implement only the minimal code needed for functionality. For example, in `lib/internal/options`, add parsing for the required options only. | ||
|
||
## Final Steps | ||
|
||
- After making the updates, thoroughly test the package to ensure it functions correctly with the changes. | ||
- Document any significant updates to maintain a clear record for future maintenance. | ||
|
||
For any questions about this guide, please refer to @RedYetiDev. |
Oops, something went wrong.
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.
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.
Let's bring back the matrix
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.
.This package isn't compatible with v20, or with v16. It's specifically meant for v18
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 should probably be aiming for support on all supported versions of Node.js. If there's something that makes it work only for v18 but not v20, something's probably wrong.
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.
I'll look into it, but we really don't need to support v20. v20 has most features that this aims to replicate