Skip to content

update library README to include versions compatibility #694

Closed
@yangcao77

Description

@yangcao77

Which area/kind this issue is related to?

/area library

Issue Description

Was initially pointed out by @kim-tsao:

I was thinking about having a section for version compatibility wrt to parent/plugin overriding or maybe documenting this as a limitation. Users may assume full interoperability otherwise.
devfile/library#125 (comment)

We need a section in the library README, for versions compatibility. including the parent/child version limit.(parent version cannot be greater than child version)
also should document some unsupported change from 2.0.0 -> 2.1.0 / 2.1.0 -> 2.2.0 which will be resulted into non-backward-compatible. i.e. plugin components, vscodeLaunch/vscodeTask commands , etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/libraryCommon devfile library for interacting with devfiles

    Type

    No type

    Projects

    Status

    Done ✅

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions