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

NCSDK-32185: Add suit A/B sample documentation #21213

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

tomchy
Copy link
Contributor

@tomchy tomchy commented Mar 28, 2025

This PR is a continuation of the #21158, adding the missing documentation pages to unblock further sample and test development.

@tomchy tomchy requested review from a team as code owners March 28, 2025 12:04
@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Mar 28, 2025
@tomchy tomchy force-pushed the feature/suit/NCSDK-32185_Add_suit_ab_sample_docs branch from 8e1d446 to a9f1360 Compare March 28, 2025 12:06
@tomchy tomchy requested a review from FrancescoSer March 28, 2025 12:06
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Mar 28, 2025

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 9

Inputs:

Sources:

sdk-nrf: PR head: 751ff678e6a80e18cb6d191867e1b4aa3a5d6e31

more details

sdk-nrf:

PR head: 751ff678e6a80e18cb6d191867e1b4aa3a5d6e31
merge base: 52fa7533833478ecbf796c44bc5dc92e79fcbf9b
target head (main): c7651e066f200e9a4152a64307b653f1ce152339
Diff

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (19)
doc
│  ├── nrf
│  │  ├── releases_and_maturity
│  │  │  ├── releases
│  │  │  │  │ release-notes-changelog.rst
│  │  ├── samples
│  │  │  │ suit.rst
samples
│  ├── suit
│  │  ├── ab
│  │  │  ├── README.rst
│  │  │  ├── img
│  │  │  │  ├── IPUC_AB.drawio
│  │  │  │  ├── IPUC_AB.png
│  │  │  │  ├── Nordic_IPUC.drawio
│  │  │  │  ├── Nordic_IPUC.png
│  │  │  │  ├── ab_root_candidate_verification.png
│  │  │  │  ├── ab_root_candidate_verification.txt
│  │  │  │  ├── ab_root_install.png
│  │  │  │  ├── ab_root_install.txt
│  │  │  │  ├── ab_root_invoke.png
│  │  │  │  ├── ab_root_invoke.txt
│  │  │  │  ├── ab_root_payload_fetch.png
│  │  │  │  ├── ab_root_payload_fetch.txt
│  │  │  │  ├── ab_root_validate.png
│  │  │  │  ├── ab_root_validate.txt
│  │  │  │  ├── partitions.drawio
│  │  │  │  │ partitions.png

Outputs:

Toolchain

Version: 4ffa2202d5
Build docker image: docker-dtr.nordicsemi.no/sw-production/ncs-build:4ffa2202d5_8bf7ca4353

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain - Skipped: existing toolchain is used
  • ✅ Build twister
    • sdk-nrf test count: 111
  • 🟠 Integration tests
    • 🟠 test-sdk-dfu
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test_ble_nrf_config
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-ble_samples
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-chip
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_cloud
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_lwm2m
    • test-fw-nrfconnect-nrf-iot_mosh
    • test-fw-nrfconnect-nrf-iot_positioning
    • test-fw-nrfconnect-nrf-iot_samples
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-proprietary_esb
    • test-fw-nrfconnect-ps
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread
    • test-low-level
    • test-sdk-audio
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-wifi
    • test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

@tomchy tomchy force-pushed the feature/suit/NCSDK-32185_Add_suit_ab_sample_docs branch 2 times, most recently from ba151b5 to 96983e8 Compare March 28, 2025 13:52
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Mar 28, 2025

Memory footprint analysis revealed the following potential issues

applications.nrf_desktop.zdebug.uart[nrf54h20dk@0.9.0/nrf54h20/cpuapp]: RAM size increased by 2048[B] in comparison to the main[94d3942] branch. - link (cc: @MarekPieta)
applications.nrf_desktop.zrelease[nrf54h20dk@0.9.0/nrf54h20/cpuapp]: RAM size increased by 2048[B] in comparison to the main[94d3942] branch. - link (cc: @MarekPieta)

Note: This message is automatically posted and updated by the CI (latest/sdk-nrf/PR-21213/9)

@tomchy tomchy added this to the 3.0.0 milestone Mar 28, 2025
@tomchy tomchy force-pushed the feature/suit/NCSDK-32185_Add_suit_ab_sample_docs branch from 96983e8 to 5a3b095 Compare March 28, 2025 15:47
@tomchy tomchy requested a review from a team as a code owner March 28, 2025 15:47
@github-actions github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Mar 28, 2025
@tomchy tomchy force-pushed the feature/suit/NCSDK-32185_Add_suit_ab_sample_docs branch 2 times, most recently from cca1d0b to 0f84e62 Compare March 31, 2025 09:42
Copy link

@tomchy tomchy requested review from jnsgsr and ahasztag March 31, 2025 10:03
@tomchy tomchy force-pushed the feature/suit/NCSDK-32185_Add_suit_ab_sample_docs branch from 0f84e62 to 9437add Compare March 31, 2025 10:17
tomchy added 3 commits March 31, 2025 12:45
Add documentation for the SUIT sample that demonstrate
how to perform A/B updates.

Ref: NCSDK-32186

Signed-off-by: Tomasz Chyrowicz <tomasz.chyrowicz@nordicsemi.no>
Add steps to verify degraded modes, no-radio modes, recovery modes as
well as Nordic components update and push-method updates.

Ref: NCSDK-32186

Signed-off-by: Tomasz Chyrowicz <tomasz.chyrowicz@nordicsemi.no>
Add missing entries inside sdk-nrf changelog.

Ref: NCSDK-NONE

Signed-off-by: Tomasz Chyrowicz <tomasz.chyrowicz@nordicsemi.no>
@tomchy tomchy force-pushed the feature/suit/NCSDK-32185_Add_suit_ab_sample_docs branch from 9437add to 751ff67 Compare March 31, 2025 10:45
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.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants