Skip to content

Commit 850f494

Browse files
committed
Add GitHub actions for testing and linting
1 parent 6a7b856 commit 850f494

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

.github/workflows/ruff.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
name: Ruff
2+
on: [ push, pull_request ]
3+
jobs:
4+
ruff:
5+
runs-on: ubuntu-latest
6+
steps:
7+
- uses: actions/checkout@v4
8+
- uses: astral-sh/ruff-action@v1

.github/workflows/testing.yaml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Testing # Skips RL tests because stable-baselines3 comes with a lot of heavy-weight dependencies
2+
3+
on: [push]
4+
5+
jobs:
6+
test:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v4
10+
- uses: mamba-org/setup-micromamba@v1
11+
with:
12+
micromamba-version: '2.0.2-1' # any version from https://github.com/mamba-org/micromamba-releases
13+
environment-name: test-env
14+
init-shell: bash
15+
create-args: python=3.11
16+
cache-environment: true
17+
- name: Install dependencies and package
18+
run: pip install .[test]
19+
shell: micromamba-shell {0}
20+
- name: Test with pytest
21+
run: pytest tests --cov=crazyflow
22+
shell: micromamba-shell {0}

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
11
# crazyflow
22
Fast, parallelizable simulations of Crazyflies with JAX and MuJoCo.
33

4+
[![Python Version]][Python Version URL] [![Ruff Check]][Ruff Check URL] [![Documentation Status]][Documentation Status URL] [![Tests]][Tests URL]
5+
6+
[Python Version]: https://img.shields.io/badge/python-3.10+-blue.svg
7+
[Python Version URL]: https://www.python.org
8+
9+
[Ruff Check]: https://github.com/utiasDSL/crazyflow/actions/workflows/ruff.yml/badge.svg?style=flat-square
10+
[Ruff Check URL]: https://github.com/utiasDSL/crazyflow/actions/workflows/ruff.yml
11+
12+
[Documentation Status]: https://readthedocs.org/projects/crazyflow/badge/?version=latest
13+
[Documentation Status URL]: https://crazyflow.readthedocs.io/en/latest/?badge=latest
14+
15+
[Tests]: https://github.com/utiasDSL/crazyflow/actions/workflows/testing.yml/badge.svg
16+
[Tests URL]: https://github.com/utiasDSL/crazyflow/actions/workflows/testing.yml
17+
18+
419
## Architecture
520

621
<img src="/docs/img/architecture.png" width="75%" alt="Architecture">

0 commit comments

Comments
 (0)