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

doc: Update git tag format for NCS Add-Ons #21346

Closed
wants to merge 1 commit into from

Conversation

ktaborowski
Copy link
Contributor

Introduce optional --add-on suffix.

@ktaborowski ktaborowski requested review from a team as code owners April 3, 2025 06:44
@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 Apr 3, 2025
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Apr 3, 2025

CI Information

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

Inputs:

Sources:

sdk-nrf: PR head: 7d6fa7fe3f51403a91026d4dc7cc3750269b5a65

more details

sdk-nrf:

PR head: 7d6fa7fe3f51403a91026d4dc7cc3750269b5a65
merge base: 8fa8f2c7c8b5cc2f80b4f90d50ffa3db77460c03
target head (main): 8fa8f2c7c8b5cc2f80b4f90d50ffa3db77460c03
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 (1)
doc
│  ├── nrf
│  │  ├── dev_model_and_contributions
│  │  │  │ code_base.rst

Outputs:

Toolchain

Version:
Build docker image:

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

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests
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_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_thingy91
    • 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-dfu
    • 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

Copy link

github-actions bot commented Apr 3, 2025

You can find the documentation preview for this PR here.

Preview links for modified nRF Connect SDK documents:

https://ncsdoc.z6.web.core.windows.net/PR-21346/nrf/dev_model_and_contributions/code_base.html

Comment on lines 221 to 224
In the case of |NCS| Add-ons, the git tag format might be different from the |NCS| version, that add-on is based on.
Along with the version, it also has an optional ``--add-on`` suffix::

vX.Y.Z(-add-on)(-rcM)
Copy link
Contributor

Choose a reason for hiding this comment

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

@FilipZajdel , do we need this mention of add-ons here?

Copy link
Contributor

@greg-fer greg-fer Apr 7, 2025

Choose a reason for hiding this comment

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

@ktaborowski Does every add-on installation follow the standard NCS installation? If yes, should this table be also updated? https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/installation/install_ncs.html#get_the_nrf_connect_sdk_code

You might also want to check the pages edited in this PR https://github.com/nrfconnect/sdk-nrf/pull/19880/files to see where else this tag format should be mentioned or linked to.

Also, is there a JIRA task or a Confluence page associated with this change that explains where this suffix comes from? I don't see anything about it on Confluence.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I commented on Confluence here

Introduce  optional ``-add-on`` suffix.

Signed-off-by: Krzysztof Taborowski <krzysztof.taborowski@nordicsemi.no>
@ktaborowski
Copy link
Contributor Author

Closing this PR, the versioning will be described in add-on/internal documentation.

@ktaborowski ktaborowski closed this Apr 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants