platformio / platformio/platformio-core

Add semantic versioning to platforms property in library.json

Open
#4,243 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

feature LDF
Dominant language
Python
Stars
9.5k
Forks
905
Avg merge
2d 13h
Merged PRs (30d)
2

Description

  • Feature Request.

It would be nice to be able to specify a minimum platform version for which a library is suitable, i.e. by adding semantic versioning to the platforms property in the library.json

  "platforms": [
    "espressif32@^4.0.0"
  ],

Use case for this is i.e. the recent update of espressif arduino platform which has some breaking changes which could break compilation of the library if build with an earlier version of espressif platform

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 with the platforms property in library.json and trace where its values are validated and resolved. Define support for the shown espressif32@^4.0.0 form, including the minimum compatible platform behavior, and add coverage for the example and breaking-version case.

Written by the indexing model from the issue text.

Assessment

Tech stack
json
Domain
build-system
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.