mirror of
https://github.com/apple/container.git
synced 2026-09-24 23:29:51 -05:00
Update README as v1.0.0 has been reached (#2233)
Co-authored-by: Eric Ernst <eric_ernst@apple.com>
This commit is contained in:
co-authored by
Eric Ernst
parent
9a8917ca2d
commit
8ca5c80c38
@@ -99,4 +99,11 @@ Contributions to `container` are welcome and encouraged. Please see our [main co
|
||||
|
||||
## Project Status
|
||||
|
||||
The container project is currently under active development. Its stability, both for consuming the project as a Swift package and the `container` tool, is only guaranteed within patch versions, such as between 0.1.1 and 0.1.2. Minor version releases may include breaking changes until we reach a 1.0.0 release.
|
||||
The container project is under active development. Its release versions are product versions, not semantic versions.
|
||||
|
||||
The `container` CLI compatibility generally preserves backward compatibility within a major release (not breaking existing scripts), however, there may be the odd case where breaking compatibility may be necessary. **Note:** Features marked *experimental* (for example, the `k8s` subcommand) may change and do not guarantee backward compatibility.
|
||||
|
||||
The `container-apiserver` XPC API compatibility preserves forward and backward compatibility within a major version.
|
||||
Other non-public XPC helpers do not guarantee CLI or API compatibility across different versions.
|
||||
|
||||
The `container` application data provides forward compatibility only, guaranteed within one major version. Upgrading to a newer major version may require a specific upgrade path.
|
||||
|
||||
Reference in New Issue
Block a user