Skip to content

Commit 314a536

Browse files
divipillairlubos
divipillai
authored and
rlubos
committed
doc: Add information about the preview tag
Add information about the preview tag. Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
1 parent 80cb1ab commit 314a536

File tree

5 files changed

+1396
-35
lines changed

5 files changed

+1396
-35
lines changed

‎doc/nrf/dev_model_and_contributions/code_base.rst

+30-31
Original file line numberDiff line numberDiff line change
@@ -151,28 +151,31 @@ The |NCS| version numbers are assigned based on very specific criteria.
151151
They follow the ``MAJOR.MINOR.PATCH`` pattern (also further called as ``X.Y.Z``), with possible additional postfixes depending on the release.
152152
All releases are accompanied by their respective :ref:`release_notes`.
153153

154-
+----------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
155-
| Release type | Release criteria | Comments |
156-
+============================+============================================================================+======================================================================================================================================+
157-
| ``MAJOR`` | Introduces a large number of substantial changes across the board | Major version number is increased rarely. |
158-
| | | Major releases are always accompanied by a :ref:`migration guide <migration_guides>`. |
159-
+----------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
160-
| ``MINOR`` | Introduces one or more new functionalities. | Version number is increased every time a minor release is cut. |
161-
| | | Minor releases are the default types of an |NCS| release and usually are accompanied by a :ref:`migration guide <migration_guides>`. |
162-
| | | The new functionalities may break existing APIs. |
163-
+----------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
164-
| ``PATCH`` | Introduces bugfixes or minor changes to the existing functionalities. | Patch releases only address functional issues and do not introduce new functionalities. |
165-
| | | Patch releases do not come with :ref:`migration guide <migration_guides>`. |
166-
+----------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
167-
| ``MAJOR.MINOR.99`` | The ``99`` added at the end of the version number indicates | The number can be used between minor, major, or patch releases. |
168-
| | that the version string is a point in between two releases. | |
169-
| | Such version does not belong to a release and corresponds to the | |
170-
| | current state of development. | |
171-
+----------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
172-
| ``MAJOR.MINOR.PATCH-devN`` | Development tag, marked through a postfix added to the end of the version. | Not part of the regular release cycle. |
173-
| | Indicates a snapshot of the development state that is created to highlight | The ``-devN`` version might not be subjected to the same amount of testing as a regular |NCS| release. |
174-
| | the introduction of a new piece of functionality. | |
175-
+----------------------------+----------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
154+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
155+
| Version | Description |
156+
+================================+======================================================================================================================================+
157+
| ``MAJOR`` | Introduces a large number of substantial changes across the board. |
158+
| | Major version number is increased rarely. |
159+
| | Major releases are always accompanied by a :ref:`migration guide <migration_guides>`. |
160+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
161+
| ``MINOR`` | Introduces one or more new functionalities. |
162+
| | Version number is increased every time a minor release is cut. |
163+
| | Minor releases are the default types of an |NCS| release and usually are accompanied by a :ref:`migration guide <migration_guides>`. |
164+
| | The new functionalities may break existing APIs. |
165+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
166+
| ``PATCH`` | Introduces bug fixes or minor changes to the existing functionalities. |
167+
| | Patch releases only address functional issues and do not introduce new functionalities. |
168+
| | Patch releases do not come with :ref:`migration guide <migration_guides>`. |
169+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
170+
| ``MAJOR.MINOR.99`` | The ``99`` added at the end of the version number indicates that the version string is a point in between two releases. |
171+
| | Such version does not belong to a release and corresponds to the current state of development. |
172+
| | The number can be used between minor, major, or patch releases. |
173+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
174+
| ``MAJOR.MINOR.PATCH-previewN`` | A preview of one or more new functionalities. |
175+
| | A preview tag is recommended for development for users who are in the initial phase of product development |
176+
| | and need to add new features of the |NCS|. |
177+
| | The ``-previewN`` version is verified using automated test suites only. |
178+
+--------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
176179

177180
There are two fundamental revisions that are relevant to most |NCS| users:
178181

@@ -199,19 +202,15 @@ A release candidate postfix ``-rcN`` can be optionally attached if the tag ident
199202

200203
The Git tags are composed as follows::
201204

202-
vX.Y.Z(-rcN|-devN)
205+
vX.Y.Z(-rcN|-previewN)
203206

204207
Tags without a suffix correspond to official releases tested and signed by Nordic Semiconductor engineers.
205208
A release candidate suffix ``-rcN`` is attached if the tag identifies a candidate instead of the actual release.
206209

207-
.. dev_tag_definition_start
208-
209-
In between releases, there might be development tags.
210-
These are identified by a ``-devN`` suffix included after the |NCS| version, for example ``v1.9.99-dev1`` for the main branch or ``v1.9.2-dev1`` for the release branch.
211-
Such versions indicate a snapshot of the development state that is created to highlight the introduction of a new piece of functionality.
212-
Unlike an |NCS| release, a ``-devN`` version may or may not have received the same amount of testing.
213-
214-
.. dev_tag_definition_end
210+
In between releases, there might be development tags, called preview tags.
211+
These are identified by a ``-previewN`` suffix included after the |NCS| version, for example ``v2.8.0-preview1``.
212+
Such versions are recommended for development for users who are in the initial phase of product development and need to add new features of the |NCS|.
213+
Unlike an |NCS| release, a ``-previewN`` version version is verified using automated test suites only.
215214

216215
In the case of OSS repositories, the git tag format reuses the upstream project's version along with some |NCS| specific postfixes::
217216

‎doc/nrf/installation/install_ncs.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -210,8 +210,8 @@ Simply put, you can work with the following versions of the |NCS|:
210210
* - Specific release (recommended)
211211
- Release tag (for example, |release_tt|)
212212
- :ref:`Release_notes` of the release
213-
* - :ref:`Development tag <dm-revisions>`
214-
- Development tag (for example, ``v1.9.2-dev1``)
213+
* - :ref:`Preview tag <dm-revisions>`
214+
- Development tag (for example, ``v2.8.0-preview1``)
215215
- :ref:`Changelog <release_notes>` of the tag
216216
* - Branch
217217
- Branch name (for example, ``main``)
@@ -296,11 +296,11 @@ For more information about the repository and development model, see the :ref:`d
296296
297297
west init -m https\://github.com/nrfconnect/sdk-nrf --mr |release| |release|
298298
299-
* **Development tag:** To check out the ``v1.9.2-dev1`` tag, enter the following command:
299+
* **Preview tag:** To check out the ``v2.8.0-preview1`` tag, enter the following command:
300300

301301
.. code-block:: console
302302
303-
west init -m https://github.com/nrfconnect/sdk-nrf --mr v1.9.2-dev1 v1.9.2-dev1
303+
west init -m https://github.com/nrfconnect/sdk-nrf --mr v2.8.0-preview1
304304
305305
* **Branch**: To check out the ``main`` branch that includes the latest state of development, enter the following command:
306306

‎doc/nrf/releases_and_maturity/release_notes.rst

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ This page is included only in the latest documentation, because it might contain
2424
releases/release-notes-2.9.0-nRF54H20-1-rc2
2525
releases/release-notes-2.9.0
2626
releases/release-notes-2.8.0
27+
releases/release-notes-2.8.0-preview1
2728
releases/release-notes-2.7.99-cs2
2829
releases/release-notes-2.7.99-cs1
2930
releases/release-notes-2.7.0

0 commit comments

Comments
 (0)