diff --git a/.github/workflows/nightly.yaml b/.github/workflows/nightly.yaml new file mode 100644 index 00000000..4b3e3294 --- /dev/null +++ b/.github/workflows/nightly.yaml @@ -0,0 +1,34 @@ +name: pip install odrive (nightly) + +on: + schedule: + - cron: '0 2 * * *' # run at 2 AM UTC + +jobs: + nightly: + strategy: + fail-fast: false + matrix: + os: [ubuntu-latest, windows-latest, macOS-latest] + #pip: [pip2, pip3] + + runs-on: ${{ matrix.os }} + steps: + - name: Install odrivetool + run: | + pip install monotonic # TODO: this is dishonest. Must be removed as soon as v0.5.0 is published! + pip install odrive + + # This one currently fails because Github Actions runs pip as non-root + #- name: Check if udev rules were set up properly + # if: matrix.os == 'ubuntu-latest' + # run: test -f /etc/udev/rules.d/91-odrive.rules + + # This step is mentioned in the user guide + - name: Add ~/.local/bin to path + if: matrix.os == 'ubuntu-latest' + run: echo "::add-path::~/.local/bin" + + - name: Launch odrivetool + # This returns a non-zero exit code if the odrivetool throws an exception + run: echo 'quit()' | odrivetool shell diff --git a/README.md b/README.md index 915c1636..eb3cea15 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ This project is all about accurately driving brushless motors, for cheap. The ai | master | [![Build Status](https://travis-ci.org/madcowswe/ODrive.png?branch=master)](https://travis-ci.org/madcowswe/ODrive) | | devel | [![Build Status](https://travis-ci.org/madcowswe/ODrive.png?branch=devel)](https://travis-ci.org/madcowswe/ODrive) | +[![pip install odrive (nightly)](https://github.com/madcowswe/ODrive/workflows/pip%20install%20odrive%20(nightly)/badge.svg)](https://github.com/madcowswe/ODrive/actions?query=workflow%3A%22pip+install+odrive+%28nightly%29%22) Please refer to the [Developer Guide](https://docs.odriverobotics.com/developer-guide) to get started with ODrive firmware development. diff --git a/docs/getting-started.md b/docs/getting-started.md index 07b298d8..64251c57 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -133,7 +133,7 @@ Try step 5 again sudo udevadm control --reload-rules sudo udevadm trigger ``` -3. **Ubuntu**, **Raspbian**: If you can't invoke `odrivetool` at this point, try adding `~/.local/bin` to your `$PATH` ([see related bug](https://unix.stackexchange.com/a/392710/176715)). This is done for example by running `nano ~/.bashrc`, scrolling to the bottom, pasting `PATH=$PATH:~/.local/bin`, and then saving and closing, and close and reopen the terminal window. +3. **Ubuntu**, **Raspbian**: If you can't invoke `odrivetool` at this point, try adding `~/.local/bin` to your `$PATH` ([see related bug](https://unix.stackexchange.com/a/392710/176715)). This is done for example by running `nano ~/.bashrc`, scrolling to the bottom, pasting `export PATH=$PATH:~/.local/bin`, and then saving and closing, and close and reopen the terminal window. ## Firmware **ODrive v3.5 and later**