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.

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

docs: Versioning policy #3488

Merged
merged 22 commits into from
Aug 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
519f338
docs: create `versioning.rst` placeholder
dangotbanned Jul 20, 2024
4cbc43d
docs: add link to `roadmap.rst`
dangotbanned Jul 20, 2024
934517a
docs: Initial `versioning.rst` draft
dangotbanned Jul 20, 2024
15ed163
Merge remote-tracking branch 'vega-altair/main' into versioning-policy
dangotbanned Jul 20, 2024
71d4856
Merge branch 'main' into versioning-policy
dangotbanned Jul 20, 2024
f465b6c
Merge branch 'main' into versioning-policy
dangotbanned Jul 22, 2024
e9a054c
Merge branch 'main' into versioning-policy
dangotbanned Jul 23, 2024
b3273ee
Merge branch 'main' into versioning-policy
dangotbanned Jul 23, 2024
69740e2
Merge branch 'main' into versioning-policy
dangotbanned Jul 24, 2024
d97d5d9
Merge branch 'main' into versioning-policy
dangotbanned Jul 25, 2024
0ff1531
docs: fix version number in italics
dangotbanned Jul 25, 2024
e0a3d69
docs: add `Version numbers` heading
dangotbanned Jul 25, 2024
68a7a52
docs: add `Deprecation` section
dangotbanned Jul 25, 2024
170ba3b
Merge branch 'main' into versioning-policy
dangotbanned Jul 27, 2024
4afee14
Merge branch 'main' into versioning-policy
dangotbanned Jul 29, 2024
5d6af8b
Merge branch 'main' into versioning-policy
dangotbanned Jul 31, 2024
52395a2
docs: Clarify upstream breaking -> warning option
dangotbanned Jul 31, 2024
dc67152
docs: add undoc statement
dangotbanned Jul 31, 2024
0d6d20c
docs: Clearly define **Public API**
dangotbanned Jul 31, 2024
e8c0cf1
docs: Tweak formatting of deprecation section
dangotbanned Jul 31, 2024
9a5aad6
Merge branch 'main' into versioning-policy
dangotbanned Jul 31, 2024
3aeeca2
Merge branch 'main' into versioning-policy
dangotbanned Aug 2, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/about/roadmap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ The roadmap for Vega-Altair and related projects can be found in
code_of_conduct
governance
citing
versioning
46 changes: 46 additions & 0 deletions doc/about/versioning.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
Versioning
==========
Vega-Altair has historically released major versions that coincide with those of Vega-Lite_.

As the projects have matured, and major versions become less frequent, there has been a growing need to introduce breaking changes between these major versions.
Such changes would allow Vega-Altair to address technical debt and improve upon API ergonomics.

To ensure future releases clearly communicate changes, Vega-Altair will be working towards adopting SemVer_.

Public API
----------
Functionality documented in :ref:`api` defines the Vega-Altair public API.

Version numbers
---------------

A Vega-Altair release number is composed of ``MAJOR.MINOR.PATCH``.

* Backward incompatible API changes increment **MAJOR** version (``4.2.2`` - ``5.0.0``)
* New backward compatible functionality increment **MINOR** version (``5.2.0`` - ``5.3.0``)
* Backward compatible bug fixes increment **PATCH** version (``5.1.1`` - ``5.1.2``)

**MAJOR** versions will *likely* continue to increase with a **MAJOR** increment to Vega-Lite_.

Deprecation
-----------
Deprecation warnings may be introduced in **MAJOR** and **MINOR** versions,
but the removal of deprecated functionality will not occur until *at least* the next **MAJOR** version.

For upstream breaking changes that trigger a **MAJOR** version,
we *may* provide a deprecation warning if we consider the change especially disruptive.

Starting in version ``5.4.0``, all deprecation warnings *must* specify:

* the version number they were introduced

Where possible, deprecation warnings *may* specify:

* an alternative function/method/parameter/class to use instead
* an explanation for why this change had to be made

Deprecated functionality *may* be removed from the Vega-Altair documentation, if there is a
suitable replacement and we believe inclusion of both could confuse new users.

.. _Vega-Lite: https://github.com/vega/vega-lite
.. _SemVer: https://semver.org/