chore: Migrate to Yarn 4, use JS constraints #156
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -21,21 +21,21 @@ jobs: | |
| contents: write | ||
| pull-requests: write | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| # This is to guarantee that the most recent tag is fetched. | ||
| # This can be configured to a more reasonable value by consumers. | ||
| fetch-depth: 0 | ||
| # We check out the specified branch, which will be used as the base | ||
| # branch for all git operations and the release PR. | ||
| ref: ${{ github.event.inputs.base-branch }} | ||
| - name: Install Node.js | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version-file: '.nvmrc' | ||
| - uses: MetaMask/action-create-release-pr@v3 | ||
| with: | ||
| release-type: ${{ github.event.inputs.release-type }} | ||
| release-version: ${{ github.event.inputs.release-version }} | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -10,7 +10,7 @@ jobs: | |
| name: Check workflows | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - name: Download actionlint | ||
| id: download-actionlint | ||
| run: bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/7fdc9630cc360ea1a469eed64ac6d78caeda1234/scripts/download-actionlint.bash) 1.6.23 | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -21,14 +21,19 @@ jobs: | |
| - name: Ensure `destination_dir` is not empty | ||
| if: ${{ inputs.destination_dir == '' }} | ||
| run: exit 1 | ||
| - uses: actions/checkout@v4 | ||
| - name: Install Corepack via Node | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version-file: '.nvmrc' | ||
| - name: Install Yarn | ||
| run: corepack enable | ||
| - name: Restore Yarn cache | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version-file: '.nvmrc' | ||
| cache: 'yarn' | ||
| - name: Install dependencies via Yarn | ||
| run: yarn --immutable | ||
| - name: Run build script | ||
| run: yarn build:docs | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -16,37 +16,51 @@ jobs: | |
| contents: write | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ github.sha }} | ||
| - name: Install Corepack via Node | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version-file: '.nvmrc' | ||
| - name: Install Yarn | ||
| run: corepack enable | ||
| - name: Restore Yarn cache | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version-file: '.nvmrc' | ||
| cache: 'yarn' | ||
| - uses: MetaMask/action-publish-release@v3 | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| - uses: actions/cache@v3 | ||
| with: | ||
| path: | | ||
| ./dist | ||
| ./node_modules/.yarn-state.yml | ||
| key: ${{ github.sha }} | ||
| - run: yarn --immutable | ||
| - run: yarn build | ||
|
|
||
| publish-npm-dry-run: | ||
| needs: publish-release | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ github.sha }} | ||
| - name: Install Corepack via Node | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version-file: '.nvmrc' | ||
| - name: Install Yarn | ||
| run: corepack enable | ||
| - name: Restore Yarn cache | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version-file: '.nvmrc' | ||
| cache: 'yarn' | ||
| - uses: actions/cache@v3 | ||
| with: | ||
| path: | | ||
| ./dist | ||
|
|
@@ -62,15 +76,25 @@ jobs: | |
| SKIP_PREPACK: true | ||
|
|
||
| publish-npm: | ||
| needs: publish-npm-dry-run | ||
| runs-on: ubuntu-latest | ||
| environment: npm-publish | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ github.sha }} | ||
| - name: Install Corepack via Node | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version-file: '.nvmrc' | ||
| - name: Install Yarn | ||
| run: corepack enable | ||
| - name: Restore Yarn cache | ||
| uses: actions/setup-node@v4 | ||
| with: | ||
| node-version-file: '.nvmrc' | ||
| cache: 'yarn' | ||
| - uses: actions/cache@v3 | ||
| with: | ||
| path: | | ||
| ./dist | ||
|
|
@@ -86,21 +110,21 @@ jobs: | |
| SKIP_PREPACK: true | ||
|
|
||
| get-release-version: | ||
| needs: publish-npm | ||
| runs-on: ubuntu-latest | ||
| outputs: | ||
| RELEASE_VERSION: ${{ steps.get-release-version.outputs.RELEASE_VERSION }} | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| ref: ${{ github.sha }} | ||
| - id: get-release-version | ||
| shell: bash | ||
| run: ./scripts/get.sh ".version" "RELEASE_VERSION" | ||
|
|
||
| publish-release-to-gh-pages: | ||
| name: Publish docs to `${{ needs.get-release-version.outputs.RELEASE_VERSION }}` directory of `gh-pages` branch | ||
| needs: get-release-version | ||
| permissions: | ||
| contents: write | ||
| uses: ./.github/workflows/publish-docs.yml | ||
|
|
@@ -110,8 +134,8 @@ jobs: | |
| PUBLISH_DOCS_TOKEN: ${{ secrets.PUBLISH_DOCS_TOKEN }} | ||
|
|
||
| publish-release-to-latest-gh-pages: | ||
| name: Publish docs to `latest` directory of `gh-pages` branch | ||
| needs: publish-npm | ||
| permissions: | ||
| contents: write | ||
| uses: ./.github/workflows/publish-docs.yml | ||
|
|
||
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.
Node.js v16 is still supported (as it very much should IMO, since there are existing downstreams still supporting it) so we ought to cover this version in tests, as long as it's still supported?
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.
Supported by whom? It's been EOL for almost a year: https://nodejs.org/en/about/previous-releases
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.
By
@metamask/eth-json-rpc-infura, which depends on this package. So this will prevent upgrade there until the same breakage is made downstream?Just noting that in general:
If you only rely on public free support options, yes, it's EoL from perspective of Node.js maintainers. However, many users receive their Node.js versions from other maintainers and can and will still run older versions by virtue of external vendor maintenance! This typically includes bugfixes and security updates.
Some examples of popular usage of even older Node versions:
Just because Node.js devs say "this version is now dead" does not make it so. Even if we could choose to align with their support cycle, it's not a given.