Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add feature stability and deprecation docs #400

Merged
merged 1 commit into from
Feb 9, 2022
Merged

Add feature stability and deprecation docs #400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 10 additions & 0 deletions DEPRECATIONS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Deprecations

This doc lists deprecated features in `fulcio`.
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 |
| | | |
| | | |
15 changes: 15 additions & 0 deletions FEATURES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Feature Stability

This doc covers feature stability in `fulcio` as described in the [API Stability Policy](https://docs.sigstore.dev/api-stability) for Sigstore.

## Experimental


## Beta
* The Fulcio API, defined [here](https://github.com/sigstore/fulcio/blob/main/pkg/api/client.go)
* Support for various Certificate Authorities (CAs), including Google Private CA Service, PKCS11, and File backed CA
* Support for SPIFFE challenges and OIDC based email challenges
* The Go client library defined in `fulcio/pkg`
* Issuers defined in [fulcio-config.yaml](https://github.com/sigstore/fulcio/blob/main/config/fulcio-config.yaml)

## General Availability