oras-project
Promote maturity of experimental and preview feature commands and flags
ORAS has introduced three feature marks to divide the CLI command feature maturity into three stages:
- Experimental: This feature can radically change or completely disappear at any time. It may be in development but for the early trial.
- Preview: This feature development is almost done and is closing to stable.
- Stable: This feature is mature and the corresponding feature mark is no longer needed.
We should consider promoting maturity of experimental and preview feature commands and flags in oras before oras v1.3.0 is released. Here are some preview and experimental flags and commands. We need to scan all commands and flags to update the feature mark in CLI help info.
- [ ] Preview and experimental Commands
| Command | Stage | Description |
|---|---|---|
| oras attach | Preview | Attaches additional files (e.g. SBOMs) to existing artifacts |
| oras discover | Preview | Finds artifacts that reference a particular manifest |
| oras resolve | Experimental | Retrieves the digest (ID) of a specified artifact |
- [ ] Preview and experimental flags
| Command | Flag | Status | Purpose |
|---|---|---|---|
| CLI-wide | --distribution-spec | Preview | Set Referrers API version |
| CLI-wide | --format | Experimental | Custom formatted output |
| CLI-wide | --no-tty | Preview | Suppress progress bar |
| CLI-wide | --image-spec | Preview | Control image-spec behavior globally |
| CLI-wide | --format | Experimental | Format output from discover |
oras discover is still unstable. I'd like to keep it and related stuffs in Preview for v1.3.0.
I would suggest these commands remain in their original state because they are unstable or were introduced in v1.3.0-alpha/beta releases, and may undergo changes in the future:
- oras manifest index
- oras discover
- oras manifest index create
- oras manifest index update
- oras backup
- oras restore
Suggest CLI-wide flags remain in their original state because they are unstable or were introduced in v1.3.0-alpha/beta releases, and may undergo changes in the future:
--artifact-platform
--distribution-spec
--image-spec
--no-tty
--oci-layout-path
Suggest the following flags of oras cp remain in their original state because they are unstable or were introduced in v1.3.0-alpha/beta releases, and may undergo changes in the future:
These flags of remain original state since they are unstable or introduced in v1.3.0-alpha/beta releases, potential changes might come in the future:
--from-oci-layout-path
--from-distribution-spec
--to-distribution-spec
--to-oci-layout-path
Suggest the following flags of oras discover remain in their original state because they are unstable or were introduced in v1.3.0-alpha/beta releases, and may undergo changes in the future:
--depth