Skip to content

Conversation

@BelfordZ
Copy link
Contributor

@BelfordZ BelfordZ commented May 22, 2025

User description

Summary

  • update engines field to Node 20
  • use Node 20 in CI workflow
  • bump .nvmrc version

Testing

  • npm test

PR Type

enhancement


Description

  • Update Node.js compatibility to version 20.11.1

  • Set Node.js version 20 in CI workflows

  • Update .nvmrc to Node.js v20.11.1


Changes walkthrough 📝

Relevant files
Enhancement
ci.yml
Use Node.js 20 in CI workflows                                                     

.github/workflows/ci.yml

  • Set Node.js version to 20 for both 'ci-test-only' and 'ci' jobs
  • Remove use of variable for Node.js version in favor of explicit
    version
  • +2/-2     
    .nvmrc
    Bump .nvmrc to Node.js v20.11.1                                                   

    .nvmrc

    • Update Node.js version from v18.19.1 to v20.11.1
    +1/-1     
    package.json
    Specify Node.js 20.11.1 in engines field                                 

    package.json

    • Update engines.node field from 18.19.1 to 20.11.1
    +1/-1     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @github-actions
    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🏅 Score: 95
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Node Version Hardcoding

    The Node.js version is now hardcoded as '20' in the CI workflow instead of using a variable. This could reduce flexibility for future upgrades or environment-specific overrides. Confirm this is intentional and aligns with project standards.

        node-version: 20
        lint-required: ${{ vars.IS_LINT_REQUIRED == 'true' }}
        format-check-required: ${{ vars.IS_FORMAT_CHECK_REQUIRED == 'true' }}
        apply-patches-required: ${{ vars.IS_APPLY_PATCHES_REQUIRED == 'true' }}
        unit-tests-required: ${{ vars.IS_UNIT_TESTS_REQUIRED == 'true' }}
      secrets: inherit
    
    ci:
      if: ${{ github.event.inputs.workflowBranch == 'main' || !github.event.inputs.workflowBranch }}
      uses: shardeum/github-automation/.github/workflows/reusable-node-ci.yml@main
      permissions:
        issues: write
        pull-requests: write
        contents: write
      with:
        node-version: 20
    Node Version Consistency

    The .nvmrc file is updated to v20.11.1, but the CI workflow specifies '20' (not the full version). Ensure this does not cause version mismatches between local and CI environments.

    v20.11.1

    @github-actions
    Copy link

    PR Code Suggestions ✨

    No code suggestions found for the PR.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    2 participants