Skip to content

Commit dfdfe06

Browse files
committed
docs: Update Versions file with the communication of releases (box/box-codegen#979)
1 parent cc39492 commit dfdfe06

2 files changed

Lines changed: 9 additions & 3 deletions

File tree

.codegen.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{ "engineHash": "fafa70b", "specHash": "86fcc6c", "version": "10.14.0" }
1+
{ "engineHash": "a50b08a", "specHash": "86fcc6c", "version": "10.14.0" }

VERSIONS.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,15 @@ When a new feature set comes online or a small breaking change is introduced, th
1010

1111
The MAJOR version is used to indicate the family of technology represented by the library. Breaking changes that require extensive reworking of code will cause the MAJOR version to be incremented by one, and the MINOR and PATCH versions will be reset to zero. Since frequent major updates can be very disruptive, we will only introduce this type of breaking change when absolutely necessary.
1212

13-
New MAJOR versions will be communicated in advance via:
13+
## Support lifecycle
1414

15-
- Box SDK documentation, such as API reference documentation, user guides, SDK product marketing pages, and GitHub readme(s) are updated to indicate the campaign timeline and provide guidance on upgrading affected applications.
15+
Each Box SDK README publishes a **[Version schedule](README.md#version-schedule)** table. That table is the source of truth for which **major versions** are **Supported**, when each was first released, and when each reaches **end of life (EOL)**.
16+
17+
After a major version reaches EOL it no longer receives new features, bug fixes, or security patches. Existing applications that pin that version continue to run, but you should plan to upgrade. The version is then marked `EOL` in the README schedule.
18+
19+
Major version releases, breaking changes, and EOL dates are announced through public channels via:
20+
21+
- Box developer documentation, such as the API reference, user guides, and GitHub READMEs.
1622
- Deprecation warnings are added to the SDKs, outlining the path to end-of-support and linking to the SDK documentation.
1723

1824
Deprecations are introduced in minor releases. We will not introduce new deprecations in patch releases. These deprecations will preserve the existing behaviour while emitting a warning that provide guidance on:

0 commit comments

Comments
 (0)