Skip to content

Commit fd468ac

Browse files
mikeromardgitbook-bot
authored andcommitted
GITBOOK-9109: vc: Apply Breaking changes process
1 parent fcfa802 commit fd468ac

File tree

2 files changed

+58
-29
lines changed

2 files changed

+58
-29
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
* [What is Snyk?](what-is-snyk.md)
66
* [Getting started](getting-started/README.md)
77
* [Explore the Snyk Web UI](getting-started/snyk-web-ui.md)
8-
* [Snyk Release Process](getting-started/snyk-release-process.md)
8+
* [Snyk release process](getting-started/snyk-release-process.md)
99
* [Glossary](getting-started/glossary.md)
1010
* [Supported languages, package managers, and frameworks](supported-languages-package-managers-and-frameworks/README.md)
1111
* [Technical specifications and guidance](supported-languages-package-managers-and-frameworks/technical-specifications-and-guidance.md)
Lines changed: 57 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,41 @@
1-
# Snyk Release Process
2-
3-
Snyk features are provided to users in the following types of releases.
1+
# Snyk release process
42

53
{% hint style="info" %}
6-
Not all features follow all these stages, and timelines for each feature to move stages vary depending on the feature.
4+
Not all features follow all these stages, and timelines for each feature vary.
75
{% endhint %}
86

9-
## Alpha
7+
## Feature release stages
108

11-
<table><thead><tr><th width="240">Description</th><th>Available to</th><th>Access</th><th>Docs</th></tr></thead><tbody><tr><td>Internal release only.</td><td>Snyk internal users, potentially some design partners.</td><td>Controlled </td><td>No docs provided.</td></tr></tbody></table>
9+
Snyk features are provided to users in the following release stages.
1210

13-
## Closed Beta
11+
<table><thead><tr><th>Stage</th><th width="195.8680419921875">Description</th><th>Available to</th><th>Access</th><th>Docs</th></tr></thead><tbody><tr><td><strong>Alpha</strong></td><td>Internal release only</td><td>Snyk internal users, potentially some design partners</td><td>Controlled </td><td>No documentation provided</td></tr><tr><td><strong>Closed Beta</strong></td><td>The first customer-facing rollout of a feature</td><td>A preselected group of users</td><td>Invitation only</td><td>Provided but not public</td></tr><tr><td><strong>Early Access</strong></td><td>Feature is tested and ready for use, but not available by default. See <a href="snyk-release-process.md#early-access-features">Early Access features</a></td><td>All users on an opt-in basis. This may include some additional purchase costs</td><td>Opt-in: on request through Snyk account team, or using Snyk Preview</td><td>Public documentation</td></tr><tr><td><strong>General Availability</strong></td><td>Feature is fully enabled</td><td>All users, subject to standard feature availability</td><td>Available by default</td><td>Full public documentation</td></tr></tbody></table>
1412

15-
<table><thead><tr><th width="243">Description</th><th>Available to</th><th>Access</th><th>Docs</th></tr></thead><tbody><tr><td>The first customer-facing rollout of a feature.</td><td>A preselected group of users.</td><td>On invitation by Snyk.</td><td>Provided but may not be public.</td></tr></tbody></table>
13+
## Feature lifecycle stages
1614

17-
## Early Access
15+
<table><thead><tr><th>Stage</th><th>Description</th><th width="131.5997314453125">Available to</th><th>Access</th><th>Docs</th></tr></thead><tbody><tr><td><strong>Deprecated</strong></td><td>The feature is available, but use is discouraged. See <a href="snyk-release-process.md#deprecated-features">Deprecated features</a></td><td>Active users only</td><td>Available by default</td><td>Full public documentation, with the Release status at the top of the page</td></tr><tr><td><strong>End of support</strong></td><td>No new support tickets will be answered. See <a href="snyk-release-process.md#end-of-support-features">End of support features</a></td><td>Active users only</td><td>Available by default</td><td>Full public documentation, with the Release status at the top of the page</td></tr><tr><td><strong>End of life</strong></td><td>The feature is no longer available</td><td>No users</td><td>Not available</td><td>No documentation available</td></tr></tbody></table>
1816

19-
<table><thead><tr><th width="246">Description</th><th>Available to</th><th>Access</th><th>Docs</th></tr></thead><tbody><tr><td>Feature is tested and ready for use, but not available by default</td><td>All users on an opt-in basis. This may include some additional purchase costs.</td><td>Opt-in: on request via Snyk account team, or via Snyk Preview</td><td>Public docs.</td></tr></tbody></table>
17+
## Brownouts
2018

21-
**Snyk features in Early Access**
19+
Brownouts occur when Snyk temporarily suspends an API endpoint or a feature, making it unavailable for use. This situation indicates that the resource or service is still operational, but its performance is reduced compared to its normal or expected capacity.
2220

23-
* [Snyk GitHub Cloud App](../scm-ide-and-ci-cd-integrations/snyk-scm-integrations/github-cloud-app.md)
24-
* Projects
21+
## Features status
2522

26-
[Automatically created Project collections](../snyk-admin/introduction-to-snyk-projects/automatically-created-project-collections.md)
23+
### Early Access features
24+
25+
* [Snyk GitHub Cloud App](../scm-ide-and-ci-cd-integrations/snyk-scm-integrations/github-cloud-app.md)
26+
* [Automatically created Project collections](../snyk-admin/introduction-to-snyk-projects/automatically-created-project-collections.md)
2727
* Snyk Code
2828
* [Snyk Code custom rules](../scan-with-snyk/snyk-code/snyk-code-custom-rules/)
2929
* [Fix code vulnerabilities automatically](../scan-with-snyk/snyk-code/manage-code-vulnerabilities/fix-code-vulnerabilities-automatically.md)
3030
* Risk Management
3131
* [Risk Score](../manage-risk/prioritize-issues-for-fixing/risk-score.md)
3232
* [Reachability analysis](../manage-risk/prioritize-issues-for-fixing/reachability-analysis.md)
33-
* Snyk Broker
34-
* [Snyk Broker commit signing](../enterprise-setup/snyk-broker/snyk-broker-commit-signing.md)
35-
* [Universal Broker](../enterprise-setup/snyk-broker/universal-broker/)
33+
* Universal Broker
3634
* Language support
3735
* [Improved .NET scanning](../supported-languages-package-managers-and-frameworks/.net/improved-.net-scanning.md)
3836
* [Snyk CLI pnpm support](../supported-languages-package-managers-and-frameworks/javascript/javascript-for-open-source.md#pnpm)
3937
* [Improved Gradle SCM scanning](../supported-languages-package-managers-and-frameworks/java-and-kotlin/git-repositories-with-maven-and-gradle.md#improved-gradle-scm-scanning-early-access)
40-
* Third-party integrations for Snyk AppRisk:&#x20;
38+
* Third-party integrations for Snyk AppRisk&#x20;
4139
* [Veracode](../manage-risk/snyk-apprisk/integrations-for-snyk-apprisk/connect-a-third-party-integration.md#veracode-setup-guide)
4240
* [Checkmarx](../manage-risk/snyk-apprisk/integrations-for-snyk-apprisk/connect-a-third-party-integration.md#checkmarx-setup-guide)
4341
* [SonarQube](../manage-risk/snyk-apprisk/integrations-for-snyk-apprisk/connect-a-third-party-integration.md#sonarqube-setup-guide)
@@ -51,22 +49,53 @@ Not all features follow all these stages, and timelines for each feature to move
5149
* [Repositories Tested in CI/CD report](../manage-issues/reporting/available-snyk-reports.md#repositories-tested-in-ci-cd-report)
5250
* [PCI-DSS v4.0.1 report](../manage-issues/reporting/available-snyk-reports.md#pci-dss-v4.0.1-report)
5351

54-
## General Availability
52+
### Deprecated features
53+
54+
Deprecated features are outdated and will be removed in the future. The documentation page will announce the transition of a feature to Deprecated six months before its start date.
55+
56+
Apps API has the following deprecated endpoints:
57+
58+
* **Revoke app bot authorization** endpoint
59+
* The [Revoke app bot authorization](../snyk-api/api-endpoints-index-and-tips/#deprecated-revoke-app-bot-authorization) endpoint is deprecated.&#x20;
60+
* Use the [Revoke app authorization for a Snyk Group with install ID](../snyk-api/api-endpoints-index-and-tips/#revoke-app-authorization-for-a-snyk-group-with-install-id) endpoint.
61+
* **Create a new app for an organization** endpoint
62+
* The [Create a new app for an organization](../snyk-api/api-endpoints-index-and-tips/#deprecated-create-a-new-app-for-an-organization) endpoint is deprecated.&#x20;
63+
* Use the [Create a new Snyk App for an organization](../snyk-api/api-endpoints-index-and-tips/#create-a-new-snyk-app-for-an-organization) endpoint.
64+
* **Get a list of apps created by an organization** endpoint
65+
* The [Get a list of apps created by an organization](../snyk-api/api-endpoints-index-and-tips/#deprecated-get-a-list-of-apps-created-by-an-organization) endpoint is deprecated.&#x20;
66+
* Use the new [Get a list of apps created by an organization](../snyk-api/api-endpoints-index-and-tips/#get-a-list-of-apps-created-by-an-organization) endpoint.
67+
* **Update app attributes that are name, redirect URIs, and access token time to live** endpoint
68+
* The [Update app attributes that are name, redirect URIs, and access token time to live](../snyk-api/api-endpoints-index-and-tips/#deprecated-update-app-attributes-that-are-name-redirect-uris-and-access-token-time-to-live) endpoint is deprecated.&#x20;
69+
* Use the [Update app creation attributes such as name, redirect URIs, and access token time to live using the App ID](../snyk-api/api-endpoints-index-and-tips/#update-app-creation-attributes-such-as-name-redirect-uris-and-access-token-time-to-live-using-the-ap) endpoint.
70+
* **Get an app by client id** endpoint
71+
* The [Get an app by client id](../snyk-api/api-endpoints-index-and-tips/#deprecated-get-an-app-by-client-id) endpoint is deprecated.&#x20;
72+
* Use the [Get a Snyk App by its App ID](../snyk-api/api-endpoints-index-and-tips/#get-a-snyk-app-by-its-app-id) endpoint.
73+
* **Delete an app** endpoint
74+
* The [Delete an app](../snyk-api/api-endpoints-index-and-tips/#deprecated-delete-an-app) endpoint is deprecated.&#x20;
75+
* Use the [Delete a Snyk App by its App ID](../snyk-api/api-endpoints-index-and-tips/#delete-an-app-by-its-app-id) endpoint.
76+
* **Manage client secrets for an app** endpoint
77+
* The [Manage client secrets for an app](../snyk-api/api-endpoints-index-and-tips/#deprecated-manage-client-secrets-for-an-app) endpoint is deprecated.&#x20;
78+
* Use the [Manage client secret for non-interactive Snyk App installations](../snyk-api/api-endpoints-index-and-tips/#manage-client-secret-for-non-interactive-snyk-app-installations) endpoint.
79+
* **Get a list of app bots authorized to an organization** endpoint
80+
* The [Get a list of app bots authorized to an organization](../snyk-api/api-endpoints-index-and-tips/#deprecated-get-a-list-of-app-bots-authorized-to-an-organization) endpoint is deprecated.&#x20;
81+
* Use the [Get a list of apps installed for an organization](../snyk-api/api-endpoints-index-and-tips/#get-a-list-of-apps-installed-for-an-organization) endpoint.
82+
83+
### End of support features
5584

56-
<table><thead><tr><th width="249">Description</th><th>Available to</th><th>Access</th><th>Docs</th></tr></thead><tbody><tr><td>Feature is fully enabled.</td><td>All users, subject to standard feature availability.</td><td>Available by default.</td><td>Full public docs.</td></tr></tbody></table>
85+
When a feature transitions to an end-of-support stage, both development and support work are terminated.&#x20;
5786

58-
## Deprecated
87+
The documentation page will announce the transition of a feature to End of Support six months before its start date.
5988

60-
<table><thead><tr><th width="256">Description</th><th>Available to</th><th>Access</th><th>Docs</th></tr></thead><tbody><tr><td>The feature is available, but use is discouraged. </td><td>Current users only</td><td>Available by default.</td><td>Full public docs, marked-up appropriately.</td></tr></tbody></table>
89+
**Snyk Docker Desktop extension**
6190

62-
## Maintenance mode
91+
The[ **Snyk Docker Desktop extension**](../scan-with-snyk/snyk-container/container-registry-integrations/integrate-with-docker-desktop-extension.md) will no longer be supported starting June 20, 2025. After this date, the extension will no longer receive updates or technical support. Until June 20, 2025, updates for this integration will only address known high-severity security vulnerabilities.&#x20;
6392

64-
<table><thead><tr><th width="256">Description</th><th>Available to</th><th>Access</th><th>Docs</th></tr></thead><tbody><tr><td>No new development or updates will be made to the feature. </td><td>Current users only</td><td>Available by default.</td><td>Full public docs, marked-up appropriately.</td></tr></tbody></table>
93+
**Recommended alternative**&#x20;
6594

66-
## End of support
95+
To avoid disruptions, Snyk recommends transitioning to scanning your container images using the [Snyk CLI](../snyk-cli/). This provides enhanced functionality, flexibility, and performance.
6796

68-
<table><thead><tr><th width="256">Description</th><th>Available to</th><th>Access</th><th>Docs</th></tr></thead><tbody><tr><td>No new support tickets will be answered. </td><td>Current users only</td><td>Available by default.</td><td>Full public docs, marked-up appropriately.</td></tr></tbody></table>
97+
### End of life features
6998

70-
## End of life
99+
A feature can also be the subject of an end-of-life event, meaning that the feature or capability impacted by this process ceases to exist and is removed from the product and public documentation.
71100

72-
<table><thead><tr><th width="256">Description</th><th>Available to</th><th>Access</th><th>Docs</th></tr></thead><tbody><tr><td>The feature is no longer available. </td><td>No users</td><td>Not available</td><td>No docs available</td></tr></tbody></table>
101+
API endpoints have a dedicated section for the end of life process and also provide details about the migration steps. Navigate to the [API End of Life process and migration guides](../api-end-of-life-eol-process-and-migration-guides/) for more details.

0 commit comments

Comments
 (0)