Skip to content

Commit

Permalink
Add GitHub actions and badges
Browse files Browse the repository at this point in the history
  • Loading branch information
amacati committed Oct 18, 2024
1 parent 77dbddb commit 5f9488d
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .github/workflows/ruff.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: Ruff
on: [ push, pull_request ]
jobs:
ruff:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: astral-sh/ruff-action@v1
21 changes: 21 additions & 0 deletions .github/workflows/testing.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Testing

on: [push]

jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.8'
cache: 'pip'
architecture: 'x64'
- name: Install dependencies
run: pip install .
- name: Test with pytest
run: |
pip install pytest pytest-cov
pytest tests.py --doctest-modules --junitxml=junit/test-results.xml --cov=com --cov-report=xml --cov-report=html
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# Autonomous Drone Racing Project Course
![ADR Banner](docs/img/banner.jpeg)
<sub><sup>AI generated image</sup></sub>
[![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)

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


## Documentation
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).

## Installation

Expand Down

0 comments on commit 5f9488d

Please sign in to comment.