mesa / mesa/mesa-frames

[Feature] Add performance benchmarks to CI/CD pipeline

Open
#129 2 comments 0 reactions 0 assignees View on GitHub
ci good first issue
Dominant language
Python
Stars
42
Forks
18
Avg merge
1m
Merged PRs (30d)
1

Description

### 🤔 Problem Description

`mesa-frames` is primarily focused on speed and performance improvements. To maintain this focus, every PR merged into the main branch should be automatically benchmarked through CI/CD using GitHub Actions.
We can create a `mesa-frames` equivalent of the [Mesa benchmarks workflow](https://github.com/projectmesa/mesa/blob/main/.github/workflows/benchmarks.yml), ensuring consistent performance tracking on every pull request.

### 💡 Proposed Solution

- Add a `benchmarks.yml` GitHub Actions workflow
- Run `mesa-frames` examples as benchmark tests on PRs targeting the `main` branch
- Ensure benchmark results are visible and ready for review during the PR process

### 🔄 Alternatives Considered

_No response_

### ➕ Additional Context

_No response_

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the referenced Mesa benchmarks workflow and the repository's existing GitHub Actions configuration. Identify the mesa-frames examples suitable for benchmark tests and determine how results can be exposed during pull requests targeting main. Done means a benchmarks.yml workflow runs those examples on each such pull request and makes results available for review.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, performance, testing-qa
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.