-
Notifications
You must be signed in to change notification settings - Fork 73
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
Updated instructions to work on mac also #101
base: master
Are you sure you want to change the base?
Changes from 3 commits
82c0999
9f045a3
66e6ad8
f825111
6963246
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -166,28 +166,38 @@ deploy: | |
1. Install arduino-cli from here: https://arduino.github.io/arduino-cli/installation/ | ||
2. Download ci-arduino | ||
* `git clone https://github.com/adafruit/ci-arduino` | ||
3. Put these lines at the end of your `.bashrc` or `.bash_profile` if you're on OSX. Make sure to fill in the path to where you installed ci-arduino and replacing USER with your username. | ||
3. Put these lines at the end of your `.bashrc` or `.bash_profile` if you're on OSX. Make sure to fill in the path to where you installed ci-arduino and replacing USER with your username. Make sure to that the libraries directory exists by installing a library first: | ||
* `arduino-cli lib install "Adafruit NeoPixel"` | ||
* Linux | ||
```bash | ||
alias test-platforms='python3 ~/path/to/ci-arduino/build_platform.py' | ||
export HOME=/home/USER/ | ||
export HOME=/home/USER | ||
``` | ||
* Mac/OSX | ||
```bash | ||
alias test-platforms='python3 ~/path/to/ci-arduino/build_platform.py' | ||
export HOME=/Users/USER | ||
export ARDUINO_LIB_DIR=/Documents/Arduino/libraries | ||
``` | ||
* Then run `source .bashrc` (Linux) or `source .bash_profile` (Mac/OSX) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should be Docker output:
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @brentru If it's mac you have to use .bash_profile. Although I am not sure if that comes pre-created on OSX There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think what brent was saying is that the path should be given within the home directory: There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh you're completely right lol |
||
4. Run this at the top level of the library you want to test | ||
```bash | ||
adafruit@adafruit:~/Adafruit_BMP183_Library$ export GITHUB_WORKSPACE=$(pwd) | ||
``` | ||
5. Remove everything in test library, and re-create it | ||
```bash | ||
adafruit@adafruit:~/Adafruit_BMP183_Library$ rm -rf ~/Arduino/libraries/Adafruit_Test_Library/; mkdir ~/Arduino/libraries/Adafruit_Test_Library | ||
adafruit@adafruit:~/Adafruit_BMP183_Library$ rm -rf $HOME$ARDUINO_LIB_DIR/Adafruit_Test_Library/; mkdir $HOME$ARDUINO_LIB_DIR/Adafruit_Test_Library | ||
``` | ||
6. Still in the top-level directory of the library you'll be testing, copy the current library to Adafruit_Test_Library | ||
```bash | ||
adafruit@adafruit:~/Adafruit_BMP183_Library$ cp * ~/Arduino/libraries/Adafruit_Test_Library/ | ||
adafruit@adafruit:~/Adafruit_BMP183_Library$ cp * $HOME$ARDUINO_LIB_DIR/Adafruit_Test_Library/ | ||
``` | ||
7. Grep for build_platform.py in githubci.yml to find out what boards to test. | ||
```bash | ||
adafruit@adafruit:~/Adafruit_BMP183_Library$ grep 'build_platform.py' .github/workflows/githubci.yml | ||
run: python3 ci/build_platform.py main_platforms | ||
``` | ||
* If nothing useful is returned, open .github/workflows/githubci.yml and find the list where the platforms to test are | ||
8. Run test-platforms. This may take a while, and tests for some boards sometimes run orders of magnitude slower than tests for other boards. | ||
```bash | ||
test-platforms main_platforms | ||
|
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.
Is there a way to do this without exporting the
HOME
alias? Could you try making another alias? ExportingHOME
ended up seriously messing up my home directory in macOS, very difficult to restore back to original alias.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.
Ooh, yeah I did not think about that. I'll change the name so it won't conflict with that.
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.
Please do!