Skip to content

Commit cab9049

Browse files
fix: Update badge URLs in README with correct repo path
Replaces the placeholder `{{GITHUB_OWNER_AND_REPO}}` with the actual repository path `legalaspro/unity_multiagent_rl` in the CI and Codecov badge URLs in the README.md file.
1 parent 6d8c2d2 commit cab9049

File tree

4 files changed

+44
-1
lines changed

4 files changed

+44
-1
lines changed

.github/workflows/ci.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Python CI
2+
3+
on: [push, pull_request]
4+
5+
jobs:
6+
build:
7+
runs-on: ubuntu-latest
8+
strategy:
9+
matrix:
10+
python-version: ["3.11"] # As specified in README
11+
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Set up Python ${{ matrix.python-version }}
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version: ${{ matrix.python-version }}
18+
- name: Install dependencies
19+
run: |
20+
python -m pip install --upgrade pip
21+
pip install -r requirements.txt
22+
# The following is needed because of the editable install for the python/ sub-package
23+
pip install -e ./python
24+
- name: Test with pytest
25+
run: |
26+
pytest --cov=algos --cov=buffers --cov=envs --cov=evals --cov=networks --cov=runners --cov=utils --cov-report=xml:coverage.xml
27+
- name: Upload coverage reports to Codecov
28+
uses: codecov/codecov-action@v4
29+
with:
30+
token: ${{ secrets.CODECOV_TOKEN }} # User will need to set this up in GitHub secrets
31+
files: coverage.xml
32+
fail_ci_if_error: true
33+
- name: Upload coverage.xml as artifact
34+
uses: actions/upload-artifact@v4
35+
with:
36+
name: coverage-report
37+
path: coverage.xml

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Unity Multi-Agent Reinforcement Learning
22

3+
[![Python Version](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
4+
[![CI Tests](https://github.com/legalaspro/unity_multiagent_rl/actions/workflows/ci.yml/badge.svg)](https://github.com/legalaspro/unity_multiagent_rl/actions/workflows/ci.yml)
5+
[![coverage status](https://codecov.io/gh/legalaspro/unity_multiagent_rl/branch/main/graph/badge.svg)](https://app.codecov.io/gh/legalaspro/unity_multiagent_rl)
6+
37
A multi-agent reinforcement learning framework for Unity environments. Provides implementations for training and evaluating MARL algorithms on collaborative and competitive tasks.
48

59
## 🎯 Project Overview

pytest.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
[pytest]
2+
addopts = --cov=algos --cov=buffers --cov=envs --cov=evals --cov=networks --cov=runners --cov=utils --cov-report=xml
23
filterwarnings =
34
ignore:Call to deprecated create function.*:DeprecationWarning:python.communicator_objects.*
45
ignore::DeprecationWarning:python.communicator_objects.*

requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,5 @@ python-dotenv>=1.0.0
1717

1818
# Testing
1919
pytest>=7.0.0
20-
pytest-mock
20+
pytest-mock
21+
pytest-cov>=2.5

0 commit comments

Comments
 (0)