-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
manifest: Matter applications versioning by VERSION file implemented #13476
Conversation
The following west manifest projects have been modified in this Pull Request:
Note: This message is automatically posted and updated by the Manifest GitHub Action. |
7c2f75c
to
a447db3
Compare
Test specificationCI/Jenkins/NRF
CI/Jenkins/integration
Detailed information of selected test modules Note: This message is automatically posted and updated by the CI |
You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds. Note: This comment is automatically posted by the Documentation Publishing GitHub Action. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would expect in this PR we should:
- align all samples and applications to start using VERSION (if this is what we want to start recommending)
- update documentation to describe both available solutions (Kconfig based and VERSION file based)
- update release notes
a447db3
to
becd29a
Compare
278b311
to
5b4b343
Compare
774c356
to
a6752ba
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about adding VERSION files to Matter bridge and weather station applications?
e5cf9c5
to
56d7f6f
Compare
doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
Outdated
Show resolved
Hide resolved
doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
Outdated
Show resolved
Hide resolved
bc1bbdf
to
83768e0
Compare
doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
Outdated
Show resolved
Hide resolved
b502a7f
to
cd9bf13
Compare
doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
Outdated
Show resolved
Hide resolved
cd9bf13
to
802416f
Compare
doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
Outdated
Show resolved
Hide resolved
802416f
to
d0f264e
Compare
Device Firmware Update (DFU) is the procedure of upgrading the application firmware version on a device. | ||
For example, you can transfer the updated images to the device by: | ||
|
||
* Upgrade over Bluetooth® Low Energy (LE). | ||
* :ref:`Upgrade over Matter (Matter OTA)<ug_matter_overview_dfu>`, where the updates are sent over the Matter fabric. | ||
|
||
Before creating and performing DFU, you need to prepare a proper versioning configuration. | ||
Versioning can be maintained by creating a :ref:`VERSION<app-version-details>` file, or by using Kconfig options. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we need description of DFU. At this point user is familiar with DFU procedure from the previous documentation pages.
What about to change this entire paragraph to something like this:
Device Firmware Update (DFU) is the procedure of upgrading the application firmware version on a device. | |
For example, you can transfer the updated images to the device by: | |
* Upgrade over Bluetooth® Low Energy (LE). | |
* :ref:`Upgrade over Matter (Matter OTA)<ug_matter_overview_dfu>`, where the updates are sent over the Matter fabric. | |
Before creating and performing DFU, you need to prepare a proper versioning configuration. | |
Versioning can be maintained by creating a :ref:`VERSION<app-version-details>` file, or by using Kconfig options. | |
To effectively deploy a Matter product, it is essential to implement application version management. This versioning is crucial for managing firmware upgrades on devices, and it is also displayed within ecosystem applications, as provided by the Basic Information cluster. | |
There are two primary approaches for maintaining versioning. It's important to note that these approaches should not be used simultaneously: | |
Utilizing a VERSION file, as detailed in the Zephyr Project documentation: [Zephyr Project Versioning](https://docs.zephyrproject.org/latest/build/version/index.html#). This method involves defining the version information in a specific file format. | |
Implementing dedicated Kconfig configurations. This approach uses Kconfig system configurations to set and manage the versioning details. | |
Choose the approach that best aligns with your project requirements and infrastructure. |
d0f264e
to
b01a036
Compare
* :kconfig:option:`CONFIG_CHIP_DEVICE_SOFTWARE_VERSION` to set to the version number. | ||
* :kconfig:option:`CONFIG_CHIP_DEVICE_SOFTWARE_VERSION_STRING` to set the version string. | ||
|
||
Additionally, since Nordic chips use MCUboot Image Tool, you need to also edit the :kconfig:option:`CONFIG_MCUBOOT_IMGTOOL_SIGN_VERSION` Kconfig option, with a value in the following format: ``"MAJOR . MINOR . PATCHLEVEL . TWEAK"``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One more comment.. Here i do see " . (dot) TWEAK" but in below examples, i do see "+" sign. Maybe all is fine, but it might be confusing.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, I didn't catch that
b01a036
to
82fe3ba
Compare
0921618
to
ef0a119
Compare
ef0a119
to
c8e12c9
Compare
c8e12c9
to
4e43418
Compare
4e43418
to
6c3700f
Compare
This commit introduces VERSION file to unify matter versioning Signed-off-by: Patryk Lipinski <[email protected]>
6c3700f
to
18adc6e
Compare
This commit introduces VERSION file to unify versioning
test_chip: PR-648