-
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
doc: Update git tag format for NCS Add-Ons #21346
Conversation
CI InformationTo view the history of this post, clich the 'edited' button above Inputs:Sources:sdk-nrf: PR head: 7d6fa7fe3f51403a91026d4dc7cc3750269b5a65 more detailssdk-nrf:
Github labels
List of changed files detected by CI (1)
Outputs:ToolchainVersion: Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped;
|
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 |
c30d5c7
to
05389ff
Compare
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) |
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.
@FilipZajdel , do we need this mention of add-ons here?
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.
@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.
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 commented on Confluence here
Introduce optional ``-add-on`` suffix. Signed-off-by: Krzysztof Taborowski <krzysztof.taborowski@nordicsemi.no>
05389ff
to
7d6fa7f
Compare
Closing this PR, the versioning will be described in add-on/internal documentation. |
Introduce optional
--add-on
suffix.