Skip to content

Conversation

@RobertGalatNordic
Copy link
Collaborator

@RobertGalatNordic RobertGalatNordic commented Mar 11, 2025

add west.yml to sidewalk project

CI parameters

Jenkins:
  test-sdk-sidewalk: add-on
  # To reconfigure functional tests:
  # use GH labels func-* (default is func-commit)
  # or
  # Use YAML Filters. Helper side to set filters: https://tester-pc.nordicsemi.no:8080/test_mgmt
  # Filters (place copied YAML filters here):
  #  - filter1:
  #     board: nrf52

TODO:

  • update Jenkins branch to use add-on build scheme

Description

JIRA ticket: KRKNWK-20045
KRKNWK-20066

nrfconnect/sdk-nrf#20901

Self review

  • There is no commented code.
  • There are no TODO/FIXME comments without associated issue ticket.
  • Commits are properly organized.
  • Change has been tested.
  • Tests were updated (if applicable).

@RobertGalatNordic RobertGalatNordic added the DNM Do Not Merge label Mar 11, 2025
@github-actions github-actions bot added source PR changing src files scripts labels Mar 11, 2025
@github-actions
Copy link

github-actions bot commented Mar 11, 2025

Sample diff used total
nrf52840dk/nrf52840:sample.sidewalk.demo RAM 0 B 125.34 KB 0 B
ROM 40 B 476.23 KB 0 B
nrf52840dk/nrf52840:sample.sidewalk.demo.ble_only RAM 0 B 109.39 KB 0 B
ROM 40 B 395.57 KB 0 B
nrf52840dk/nrf52840:sample.sidewalk.dut RAM 0 B 148.92 KB 0 B
ROM 40 B 540.85 KB 0 B
nrf52840dk/nrf52840:sample.sidewalk.dut.ble_only RAM 0 B 132.92 KB 0 B
ROM 40 B 459.51 KB 0 B
nrf5340dk/nrf5340/cpuapp:sample.sidewalk.demo RAM 0 B 116.56 KB 0 B
ROM 40 B 395.92 KB 0 B
nrf5340dk/nrf5340/cpuapp:sample.sidewalk.demo.ble_only RAM 0 B 100.76 KB 0 B
ROM 36 B 314.11 KB 0 B
nrf5340dk/nrf5340/cpuapp:sample.sidewalk.dut RAM 0 B 140.31 KB 0 B
ROM 36 B 461.9 KB 0 B
nrf5340dk/nrf5340/cpuapp:sample.sidewalk.dut.ble_only RAM 0 B 124.46 KB 0 B
ROM 40 B 379.55 KB 0 B
nrf54l15dk/nrf54l10/cpuapp:sample.sidewalk.demo RAM -1.5 KB 124.84 KB 0 B
ROM 56 B 447.31 KB 0 B
nrf54l15dk/nrf54l10/cpuapp:sample.sidewalk.demo.ble_only RAM -1.5 KB 109.24 KB 0 B
ROM 56 B 371.49 KB 0 B
nrf54l15dk/nrf54l10/cpuapp:sample.sidewalk.dut RAM -1.5 KB 148.58 KB 0 B
ROM 52 B 512.98 KB 0 B
nrf54l15dk/nrf54l10/cpuapp:sample.sidewalk.dut.ble_only RAM -1.5 KB 132.92 KB 0 B
ROM 52 B 436.6 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.demo RAM -1.5 KB 124.84 KB 0 B
ROM 56 B 447.28 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.demo.ble_only RAM -1.5 KB 109.24 KB 0 B
ROM 56 B 371.46 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.dut RAM -1.5 KB 148.58 KB 0 B
ROM 52 B 512.95 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.dut.ble_only RAM -1.5 KB 132.92 KB 0 B
ROM 52 B 436.57 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.dut.no_secure RAM -1.5 KB 148.53 KB 0 B
ROM 44 B 505.11 KB 0 B
nrf52840dk/nrf52840:sample.sidewalk.dut.no_secure RAM 0 B 148.9 KB 0 B
ROM 36 B 532.23 KB 0 B
nrf52840dk/nrf52840:sample.sidewalk.hello RAM 0 B 126.55 KB 0 B
ROM 40 B 490.62 KB 0 B
nrf52840dk/nrf52840:sample.sidewalk.hello.ble_only RAM 0 B 99.21 KB 0 B
ROM 40 B 393.89 KB 0 B
nrf5340dk/nrf5340/cpuapp:sample.sidewalk.dut.no_secure RAM 0 B 140.29 KB 0 B
ROM 36 B 454.38 KB 0 B
nrf5340dk/nrf5340/cpuapp:sample.sidewalk.hello RAM 0 B 118.04 KB 0 B
ROM 40 B 410.57 KB 0 B
nrf5340dk/nrf5340/cpuapp:sample.sidewalk.hello.ble_only RAM 0 B 90.84 KB 0 B
ROM 40 B 312.67 KB 0 B
nrf54l15dk/nrf54l10/cpuapp:sample.sidewalk.dut.no_secure RAM -1.5 KB 148.53 KB 0 B
ROM 44 B 505.14 KB 0 B
nrf54l15dk/nrf54l10/cpuapp:sample.sidewalk.hello RAM -1.5 KB 126.27 KB 0 B
ROM 56 B 461.67 KB 0 B
nrf54l15dk/nrf54l10/cpuapp:sample.sidewalk.hello.ble_only RAM -1.5 KB 99.28 KB 0 B
ROM 56 B 369.79 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.hello RAM -1.5 KB 126.27 KB 0 B
ROM 56 B 461.64 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.hello.ble_only RAM -1.5 KB 99.28 KB 0 B
ROM 56 B 369.76 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.hello.ble_only.release RAM -1.5 KB 94.65 KB 0 B
ROM 56 B 297.1 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.hello.release RAM -1.5 KB 110.27 KB 0 B
ROM 52 B 371.06 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.helloPower.ble.release RAM -1.5 KB 110.26 KB 0 B
ROM 56 B 370.31 KB 0 B
nrf52840dk/nrf52840:sample.sidewalk.hello.ble_only.release RAM 0 B 94.42 KB 0 B
ROM 40 B 323.45 KB 0 B
nrf52840dk/nrf52840:sample.sidewalk.hello.release RAM 0 B 110.38 KB 0 B
ROM 40 B 400.62 KB 0 B
nrf5340dk/nrf5340/cpuapp:sample.sidewalk.hello.ble_only.release RAM 0 B 86.22 KB 0 B
ROM 40 B 240.96 KB 0 B
nrf5340dk/nrf5340/cpuapp:sample.sidewalk.hello.release RAM 0 B 102.02 KB 0 B
ROM 40 B 318.9 KB 0 B
nrf54l15dk/nrf54l10/cpuapp:sample.sidewalk.hello.ble_only.release RAM -1.5 KB 94.65 KB 0 B
ROM 56 B 297.13 KB 0 B
nrf54l15dk/nrf54l10/cpuapp:sample.sidewalk.hello.release RAM -1.5 KB 110.27 KB 0 B
ROM 52 B 371.1 KB 0 B
nrf54l15dk/nrf54l10/cpuapp:sidewalk.test.simple_bootloader RAM 0 B 11.6 KB 0 B
ROM 4 B 43.39 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.helloPower.ble_only.release RAM -1.5 KB 94.64 KB 0 B
ROM 52 B 296.49 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.helloPower.fsk.release RAM -1.5 KB 110.26 KB 0 B
ROM 56 B 370.31 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sample.sidewalk.helloPower.lora.release RAM -1.5 KB 110.26 KB 0 B
ROM 56 B 370.31 KB 0 B
nrf54l15dk/nrf54l15/cpuapp:sidewalk.test.simple_bootloader RAM 0 B 11.38 KB 0 B
ROM 4 B 36.27 KB 0 B
thingy53/nrf5340/cpuapp:sample.sidewalk.demo.ble_only RAM 110.6 KB 110.6 KB 0 B
ROM 354.47 KB 354.47 KB 0 B
.config diff

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l10_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.hello.ble_only.release/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l10_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.dut/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l10_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.demo/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l10_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.dut.no_secure/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l10_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.hello/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l10_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.hello.release/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l10_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.demo.ble_only/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l10_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.dut.ble_only/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l10_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.hello.ble_only/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.hello.ble_only.release/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.dut/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.helloPower.ble.release/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.demo/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.dut.no_secure/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.hello/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.helloPower.ble_only.release/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.hello.release/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.demo.ble_only/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.dut.ble_only/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.helloPower.fsk.release/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.helloPower.lora.release/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

./sample-artifacts-meta/twister-out/nrf54l15dk_nrf54l15_cpuapp/zephyr/samples/sid_end_device/sample.sidewalk.hello.ble_only/sid_end_device/zephyr/.config
old                                                           | new
CONFIG_MAIN_STACK_SIZE=3584				      |	CONFIG_MAIN_STACK_SIZE=2048

@RobertGalatNordic RobertGalatNordic force-pushed the add_west_yml branch 20 times, most recently from 1f12dd6 to b713146 Compare March 12, 2025 10:53
Copy link
Contributor

@ktaborowski ktaborowski left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good. minor comments

@RobertGalatNordic RobertGalatNordic force-pushed the add_west_yml branch 4 times, most recently from 68446e8 to b59b1df Compare March 12, 2025 13:20
@github-actions github-actions bot added the manifest Change in west.yaml detected label Mar 12, 2025
@RobertGalatNordic RobertGalatNordic force-pushed the add_west_yml branch 3 times, most recently from fca9a0d to 15d637a Compare March 12, 2025 15:42
add west.yml to sidewalk project
update github actions
improve build and test in GHA,
by dynamically selecting number of runners

nrfconnect/sdk-nrf#20901

update template for PRs

Signed-off-by: Robert Gałat <[email protected]>
@RobertGalatNordic RobertGalatNordic removed the DNM Do Not Merge label Mar 13, 2025
@RobertGalatNordic RobertGalatNordic marked this pull request as ready for review March 13, 2025 11:18
update nrf version in west.yml

Signed-off-by: Robert Gałat <[email protected]>
@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Mar 18, 2025
…0070]

- Update index.rst to reflect Sidewalk's move to standalone west.yml
- Add migration_guide.rst to the main documentation toctree
- Update include_building_and_running.txt to reference new setup process
- Revise setting_up_sdk.rst with new setup process and migration steps
- Add toolchain and Python package installation instructions
- Update NCS documentation about Sidewalk configuration

The changes reflect that Sidewalk is no longer part of the NCS manifest
and now uses its own west.yml configuration, providing clearer setup
instructions for both new users and those migrating from NCS.

Signed-off-by: Robert Gałat <[email protected]>
@totyz
Copy link
Contributor

totyz commented Mar 20, 2025

@totyz
Copy link
Contributor

totyz commented Mar 20, 2025

According to documentation - I would move Moving from NCS Manifest to Standalone west.yml under Release notes and migration guides

use nrf revision that no longer mentions sidewalk

Signed-off-by: Robert Gałat <[email protected]>
This is a point of discussion how to trigger the nrf update.
for now we can manually update the nrf revision via PR
and automatic solution need to be tested fist

Signed-off-by: Robert Gałat <[email protected]>
Copy link
Contributor

@ktaborowski ktaborowski Mar 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rename migration_guide_addon_v010

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't notice your comment, I renamed it migration_guide_standalone.rst,
I think it also describes the change good enough for our need

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another migration guides are named from ncs versions so I would recommend to keep this convetion, see https://github.com/nrfconnect/sdk-sidewalk/tree/main/doc/releases_and_migration

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok I will fix it

@@ -0,0 +1,161 @@
.. _migration_guide:

Migration Guide: Moving from NCS Manifest to Standalone west.yml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Migration Guide for moving to Sidewalk Add-on ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

update documentation

Signed-off-by: Robert Gałat <[email protected]>
@RobertGalatNordic
Copy link
Collaborator Author

RobertGalatNordic commented Mar 20, 2025

According to documentation - I would move Moving from NCS Manifest to Standalone west.yml under Release notes and migration guides

documentation moved:

https://jenkins-ncs.nordicsemi.no/job/KRKNG/job/Sidewalk/job/test-sdk-sidewalk/job/add-on/25/artifact/html_doc/index.html


.. code-block:: console
# Remove the .west directory to clean the west configuration
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest moving comments to the text section instead placing in in the cosnole snippets

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that those comments in place are actually good, they does not matter if you copy/paste whole block, and they explain line by line why the command is needed

|___ nrfxlib
|___ zephyr
|___ ...
git clone https://github.com/nordicsemiconductor/sidewalk.git sidewalk
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you can initlize west form sidewalk repostoriy directly, no need to clone it with git and init west locally.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm true, you can do i both ways, I will try to add it to the doc

git clone https://github.com/nordicsemiconductor/sidewalk.git sidewalk
#. Enable the Sidewalk group filter for west.
2. If you are migrating from an existing NCS setup with Sidewalk, clean the west configuration:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest moving it to the Note section or sht with a link to migration guide instead of keeping in in setting up instructions

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@ktaborowski
Copy link
Contributor

@annwoj please review commit docs: update Sidewalk documentation for standalone west.yml

add self section to west.yml

Signed-off-by: Robert Gałat <[email protected]>
@totyz
Copy link
Contributor

totyz commented Mar 20, 2025

@totyz totyz merged commit eae8d27 into nrfconnect:main Mar 21, 2025
67 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-required PR must not be merged without tech writer approval. func-integration manifest Change in west.yaml detected scripts source PR changing src files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants