Skip to content

Commit 5f9488d

Browse files
committed
Add GitHub actions and badges
1 parent 77dbddb commit 5f9488d

File tree

3 files changed

+33
-0
lines changed

3 files changed

+33
-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.yml

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Testing
2+
3+
on: [push]
4+
5+
jobs:
6+
test:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v4
10+
- uses: actions/setup-python@v5
11+
with:
12+
python-version: '3.8'
13+
cache: 'pip'
14+
architecture: 'x64'
15+
- name: Install dependencies
16+
run: pip install .
17+
- name: Test with pytest
18+
run: |
19+
pip install pytest pytest-cov
20+
pytest tests.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
21+

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Autonomous Drone Racing Project Course
22
![ADR Banner](docs/img/banner.jpeg)
33
<sub><sup>AI generated image</sup></sub>
4+
[![Ruff Check](https://github.com/utiasDSL/lsy_drone_racing/actions/workflows/ruff.yml/badge.svg)](https://github.com/utiasDSL/lsy_drone_racing/actions/workflows/ruff.yml) [![Documentation Status](https://readthedocs.org/projects/lsy-drone-racing/badge/?version=latest&style=flat-square)](https://lsy-drone-racing.readthedocs.io/en/latest/?badge=latest)
45

56
## Table of Contents
67
- [Autonomous Drone Racing Project Course](#autonomous-drone-racing-project-course)
78
- [Table of Contents](#table-of-contents)
9+
- [Documentation](#documentation)
810
- [Installation](#installation)
911
- [Fork lsy\_drone\_racing](#fork-lsy_drone_racing)
1012
- [Using conda/mamba](#using-condamamba)
@@ -28,6 +30,8 @@
2830
- [Launch](#launch)
2931

3032

33+
## Documentation
34+
To get you started with the drone racing project, you can head over to our [documentation page](https://lsy-drone-racing.readthedocs.io/en/latest/getting_started/general.html).
3135

3236
## Installation
3337

0 commit comments

Comments
 (0)