learningequality / learningequality/studio

Change ricecooker version checks to hard warning only

Open Beginner friendly
#2,245 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

TAG: tech update / debt
Dominant language
Python
Stars
191
Forks
307
Avg merge
5d 6h
Merged PRs (30d)
10

Description

Summary

Studio should only care if a ricecooker version is not compatible with the current Studio API. Ricecooker can do its own internal version checking and recommend updates when they are available.

This means removing VERSION_OK and VERSION_[HARD|SOFT]_WARNING from ricecooker_versions.py and changing check_version to only return a generic "Your ricecooker version is compatible" OK message or a "Your version of ricecooker is not compatible. Please upgrade." error message.

Category

ENHANCEMENT

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in ricecooker_versions.py and read check_version along with the VERSION_OK and VERSION_[HARD|SOFT]WARNING definitions. Simplify the check to report only API compatibility, with the specified generic OK or upgrade error message. Done means the old version-status constants are removed and incompatible versions receive the upgrade guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.