aws-amplify / docs

AWS Amplify Framework Documentation
https://docs.amplify.aws
Apache License 2.0
483 stars 1.03k forks source link

consider adding an `.nvmrc` #5086

Closed josefaidt closed 10 months ago

josefaidt commented 1 year ago

Is your feature request related to a problem? Please describe.

Consider adding an nvmrc file to ensure contributors are using the same Node version as the build pipeline. While different node versions may not always cause an issue, they can print different error messages which would cause tests to fail locally. In the screenshot below I had corrected an error message as I was updating tests to find it error in the build workflow, where I was using Node 18 locally and the build workflow is set to use 14.

image

This nvmrc file can also be used by the build workflow:

- name: Setup Node.js 14.x
  uses: actions/setup-node@main
  with:
    node-version-file: '.nvmrc'

Describe the solution you'd like A clear and concise description of what you want to happen.

add an nvmrc and/or contributing guidelines for suggested Node version

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.

rachelnabors commented 1 year ago

I like this idea, @josefaidt!