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.

Sign up for GitHub

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

Jump to bottom

doc: Add information about the preview tag #19949

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: Add information about the preview tag #19949

wants to merge 1 commit into from

Conversation

divipillai
Copy link
Contributor

Add information about the preview tag.

@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 Jan 16, 2025
@divipillai divipillai added CI-disable Disable CI for this PR and removed changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jan 16, 2025
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jan 16, 2025 •
edited
Loading

CI Information

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

Inputs:

Sources:

more details

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 (0)

Outputs:

Toolchain

Version:
Build docker image:

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

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests

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

@divipillai divipillai force-pushed the NCSDK-30972_code_base_preview branch from 9013d50 to a5c7921 Compare January 16, 2025 13:11
@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 16, 2025
@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link.

Note: This comment is automatically posted by the Documentation Publish GitHub Action.

@divipillai divipillai requested a review from wbober January 20, 2025 08:39
wbober
wbober requested changes Jan 20, 2025
View reviewed changes
doc/nrf/dev_model_and_contributions/code_base.rst Show resolved Hide resolved
doc/nrf/dev_model_and_contributions/code_base.rst Outdated
| | Such version does not belong to a release and corresponds to the | |
| | current state of development. | |
+--------------------------------+--------------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
| ``MAJOR.MINOR.PATCH-previewN`` | Preview tag, marked through a postfix added to the end of the version. | Not part of the regular release cycle. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Let's make a combined description as:

Preview tag, marked through a postfix added to the end of the version. A preview is recommended for development for customers who are in the initial phase of product development and are in need for new features from the SDK. The -previewN is verified using automated test suites only. Please refer to the changelog for the full list of executed test suites.

Copy link
Contributor Author

@divipillai divipillai Jan 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@wbober - Regarding full list of executed test suites - Are you referring to these links in the release notes - https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/releases/release-notes-2.8.0.html#integration_test_results. These test links are provided only for the major and minor release versions towards the end of the release cycle and not for the preview tags. Hence, I haven't added the last sentence.
Please confirm.

@divipillai divipillai force-pushed the NCSDK-30972_code_base_preview branch from a5c7921 to ccd542f Compare January 21, 2025 12:53
@divipillai divipillai requested a review from wbober January 21, 2025 13:00
@divipillai divipillai force-pushed the NCSDK-30972_code_base_preview branch 3 times, most recently from f29c88c to a5c7a1e Compare January 22, 2025 09:15
@divipillai divipillai marked this pull request as ready for review January 22, 2025 09:56
@divipillai divipillai requested review from a team as code owners January 22, 2025 09:56
@divipillai divipillai removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 22, 2025
@divipillai divipillai force-pushed the NCSDK-30972_code_base_preview branch from a5c7a1e to da04fd0 Compare January 22, 2025 10:06
peknis
peknis requested changes Jan 22, 2025
View reviewed changes
doc/nrf/dev_model_and_contributions/code_base.rst Outdated Show resolved Hide resolved
doc/nrf/dev_model_and_contributions/code_base.rst Outdated Show resolved Hide resolved
@divipillai divipillai force-pushed the NCSDK-30972_code_base_preview branch 2 times, most recently from 9b6cdaa to 3d69620 Compare January 22, 2025 12:12
@divipillai divipillai requested a review from peknis January 22, 2025 12:13
greg-fer
greg-fer requested changes Jan 22, 2025
View reviewed changes
doc/nrf/dev_model_and_contributions/code_base.rst Outdated Show resolved Hide resolved
doc/nrf/dev_model_and_contributions/code_base.rst Outdated Show resolved Hide resolved
doc/nrf/dev_model_and_contributions/code_base.rst Outdated Show resolved Hide resolved
doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst Outdated Show resolved Hide resolved
doc/nrf/dev_model_and_contributions/code_base.rst Outdated Show resolved Hide resolved
@divipillai divipillai force-pushed the NCSDK-30972_code_base_preview branch from 3d69620 to 64a91c9 Compare January 22, 2025 14:28
umapraseeda
umapraseeda approved these changes Jan 24, 2025
View reviewed changes
doc/nrf/dev_model_and_contributions/code_base.rst Outdated
Comment on lines 171 to 172
| | Such version does not belong to a release and corresponds to the |
| | current state of development. |
Copy link
Contributor

Choose a reason for hiding this comment

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

Could be moved to the above line?

@divipillai
doc: Add information about the preview tag
cf3a19a 
Add information about the preview tag.

Signed-off-by: divya pillai <[email protected]>
@divipillai divipillai force-pushed the NCSDK-30972_code_base_preview branch from 64a91c9 to cf3a19a Compare January 24, 2025 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@peknis peknis peknis approved these changes

@umapraseeda umapraseeda umapraseeda approved these changes

@greg-fer greg-fer greg-fer approved these changes

@wbober wbober Awaiting requested review from wbober

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
CI-disable Disable CI for this PR doc-required PR must not be merged without tech writer approval.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@divipillai @NordicBuilder @wbober @greg-fer @umapraseeda @peknis