Skip to content
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

Install notes for arm architectures #615

Merged

Conversation

darcyparker
Copy link
Contributor

Description

Update README.md with necessary instructions to install particle-cli on some environments such as those with ARM architecture. (ie Raspberry Pi)

As well, added .node-version and .nvmrc for use with node version managers. See https://github.com/shadowspawn/node-version-usage#node-version-file-usage.

Finally, I updated the engines property in package.json because it was outdated. In my experience particle-cli only works reliably with node v12. The README.md already notes this. But it is easy to gloss over this point in the README. So having it defined in package.json provides a better warning during install. And having a .nvmrc and .node-version helps users with a node version manager ensure they are using the correct version.

How to Test

Install particle-cli on a fresh install of Raspbian on a Raspberry Pi. It will fail to work properly if the OS dependencies mentioned in the updated README.md are not installed.

Completeness

  • User is totes amazing for contributing!
  • Contributor has signed CLA
  • Problem and solution clearly stated
  • Tests have been provided
  • Docs have been updated
  • CI is passing

… version mangers

* See https://github.com/shadowspawn/node-version-usage
* Note .nvmrc is a symbolic link to .node-version and works with nvmrc
  given it honors .node-version specification.  Just don't use .nvmrc
  specific features in .node-version file.
@darcyparker
Copy link
Contributor Author

darcyparker commented Jul 20, 2021

Note: The install script mentioned here: https://docs.particle.io/tutorials/developer-tools/cli/#using-macos-or-linux
(https://raw.githubusercontent.com/spark/particle-cli-wrapper/master/installer/unix/install-cli) should probably be updated too. (particle-iot/particle-cli-wrapper#15)

I suggest:

  • Checking ARCH=$(arch) results and if it contains arm, then install the additional dependencies mentioned in the README. I only provided an example for raspbian/debian/ubuntu. I do not have an Apple M1, so I did not work out the brew example.

@darcyparker
Copy link
Contributor Author

I noticed the CI test is failing:

 AssertionError: expected [Function: functionStub] to have property 'callCount' of 0, but got 1

Is this a known intermediate error?

Copy link
Contributor

@busticated busticated left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just getting back from some PTO here - thanks for your patience. a few important notes below - if you prefer, i'm happy to take it over the finish line for you. thanks again 🙏 👍

.nvmrc Show resolved Hide resolved
README.md Show resolved Hide resolved
package.json Show resolved Hide resolved
@busticated
Copy link
Contributor

busticated commented Jul 29, 2021

I noticed the CI test is failing:

yes, it's primarily due to a security precaution in our CI provider which i haven't been able to address quite yet.

AssertionError: expected [Function: functionStub] to have property 'callCount' of 0, but got 1

that specific failure is due to this change 649f820

@darcyparker
Copy link
Contributor Author

just getting back from some PTO here - thanks for your patience. a few important notes below - if you prefer, i'm happy to take it over the finish line for you. thanks again 🙏 👍

Please do. I think you have the important information/intent of what I wanted to see fixed.

@busticated busticated merged commit fe7a35e into particle-iot:master Jul 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants