Add FEATURES.md and DEPRECATIONS.md

Signed-off-by: Priya Wadhwa <priya@chainguard.dev>
sigstore · Feb 9, 2022 · ce46165 · ce46165
1 parent 4a67440
commit ce46165
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/DEPRECATIONS.md b/DEPRECATIONS.md
@@ -0,0 +1,10 @@
+# Deprecations
+
+This doc lists deprecated features in `cosign`.
+You can read more about Sigstore's deprecation policy [here](https://docs.sigstore.dev/api-stability)!
+
+| **Feature Being Deprecated** | **API Stability Level** | **Earliest Date of Removal** |
+|------------------------------|-------------------------|------------------------------|
+| My feature                   | Experimental/Beta/GA    | DD/MM/YY                     |
+|                              |                         |                              |
+|                              |                         |                              |
diff --git a/FEATURES.md b/FEATURES.md
@@ -0,0 +1,16 @@
+# Feature Stability
+
+This doc covers feature stability in `cosign` as described in the [API Stability Policy](https://docs.sigstore.dev/api-stability) for Sigstore.
+
+Experimental:
+* Keyless signing
+* Storing signatures in a transparency log
+* The `pkg/cosign/oci` client library
+
+
+Beta:
+* All cosign subcommands, including flags and output
+
+
+General Availability:
+* None, yet!