Skip to content

Commit 9e64d0f

Browse files
authored
Add feature stability and deprecation docs (#400)
Signed-off-by: Priya Wadhwa <[email protected]>
1 parent aeab255 commit 9e64d0f

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

DEPRECATIONS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Deprecations
2+
3+
This doc lists deprecated features in `fulcio`.
4+
You can read more about Sigstore's deprecation policy [here](https://docs.sigstore.dev/api-stability)!
5+
6+
| **Feature Being Deprecated** | **API Stability Level** | **Earliest Date of Removal** |
7+
|------------------------------|-------------------------|------------------------------|
8+
| My feature | Experimental/Beta/GA | DD/MM/YY |
9+
| | | |
10+
| | | |

FEATURES.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Feature Stability
2+
3+
This doc covers feature stability in `fulcio` as described in the [API Stability Policy](https://docs.sigstore.dev/api-stability) for Sigstore.
4+
5+
## Experimental
6+
7+
8+
## Beta
9+
* The Fulcio API, defined [here](https://github.com/sigstore/fulcio/blob/main/pkg/api/client.go)
10+
* Support for various Certificate Authorities (CAs), including Google Private CA Service, PKCS11, and File backed CA
11+
* Support for SPIFFE challenges and OIDC based email challenges
12+
* The Go client library defined in `fulcio/pkg`
13+
* Issuers defined in [fulcio-config.yaml](https://github.com/sigstore/fulcio/blob/main/config/fulcio-config.yaml)
14+
15+
## General Availability

0 commit comments

Comments
 (0)