Update README for integration tests

[johlju]

Pull Request (PR) description

This Pull Request (PR) fixes the following issues

Task list

• Added an entry to the change log under the Unreleased section of the
  file CHANGELOG.md. Entry should say what was changed and how that
  affects users (if applicable), and reference the issue being resolved
  (if applicable).
• Resource documentation updated in the resource's README.md.
• Resource parameter descriptions updated in schema.mof.
• Comment-based help updated, including parameter descriptions.
• Localization strings updated.
• Examples updated.
• Unit tests updated. See DSC Community Testing Guidelines.
• Integration tests updated (where possible). See DSC Community Testing Guidelines.
• Code changes adheres to DSC Community Style Guidelines.

---

This change is 

[coderabbitai]

Walkthrough

Documentation-only updates: rewrapped text in CHANGELOG Unreleased section, added a Fixed note about tests not needing database connectivity; and updated Integration Tests README to change ConvertFrom-SqlDscDatabasePermission’s run order/dependencies to only require Prerequisites, removing the DSCSQLTEST/Install-SqlDscServer dependency.

Changes

Cohort / File(s)	Summary
Changelog updates CHANGELOG.md	Reflowed paragraph formatting; added Fixed subsection noting ConvertFrom-SqlDscDatabasePermission tests no longer require database instance connectivity; no functional changes.
Integration test docs tests/Integration/Commands/README.md	Updated run order/dependency for ConvertFrom-SqlDscDatabasePermission to depend only on Prerequisites; removed DSCSQLTEST/Install-SqlDscServer references.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Improve integration and unit tests cleanup #2293 — Adjusts integration test run-order/dependencies, including prerequisites for ConvertFrom-SqlDscDatabasePermission, matching the changes documented here.

Pre-merge checks

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description Check	❓ Inconclusive	The PR description remains the default template text and does not include any actual details about the changes made, rendering it very generic and not informative of the actual changeset.	Please update the pull request description with a concise summary of the actual changes made, including updates to the integration tests README and changelog formatting.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title Check	✅ Passed	The title concisely and clearly describes the main change—updating the integration tests README—and is directly related to the changeset without extraneous information.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

CHANGELOG.md (1)

52-57: Avoid duplicate 'Fixed' sections in Unreleased; merge this bullet into the existing Fixed section.

Unreleased already has a '### Fixed' later (see Line 138). Having two violates the changelog guidelines and also splits Added items.

Apply this diff to remove the extra heading and bullet here:

-### Fixed
-
-- Updated integration test documentation in `tests/Integration/Commands/README.md`
-  to correctly reflect that `ConvertFrom-SqlDscDatabasePermission` test does not
-  require database instance connectivity
-  [issue #2284](https://github.com/dsccommunity/SqlServerDsc/issues/2284).

Then add the same bullet under the existing Unreleased '### Fixed' section later in the file:

• Updated integration test documentation in tests/Integration/Commands/README.md to correctly reflect that ConvertFrom-SqlDscDatabasePermission test does not require database instance connectivity issue #2284.

As per changelog guidelines

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4143879 and 06124e6.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• tests/Integration/Commands/README.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (3)

**/*.md

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-markdown.instructions.md)

**/*.md: Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
Use 2 spaces for indentation in Markdown documents
Use '1.' for all items in ordered lists (1/1/1 numbering style)
Disable MD013 for tables/code blocks exceeding 80 characters via an inline comment
Require empty lines before and after code blocks and headings (except before line 1)
Escape backslashes in file paths only, not inside code blocks
All fenced code blocks must specify a language identifier
Format parameter names as bold
Format values/literals as inline code
Format resource/module/product names as italic
Format commands, file names, and paths as inline code

Files:

• tests/Integration/Commands/README.md
• CHANGELOG.md

---

⚙️ CodeRabbit configuration file

**/*.md: # Markdown Style Guidelines

• Wrap lines at word boundaries when over 80 characters (except tables/code blocks)
• Use 2 spaces for indentation
• Use '1.' for all items in ordered lists (1/1/1 numbering style)
• Disable MD013 rule by adding a comment for tables/code blocks exceeding 80 characters
• Empty lines required before/after code blocks and headings (except before line 1)
• Escape backslashes in file paths only (not in code blocks)
• Code blocks must specify language identifiers

Text Formatting

• Parameters: bold
• Values/literals: inline code
• Resource/module/product names: italic
• Commands/files/paths: inline code

Files:

• tests/Integration/Commands/README.md
• CHANGELOG.md

**

⚙️ CodeRabbit configuration file

**: # DSC Community Guidelines

Terminology

• Command: Public command
• Function: Private function
• Resource: DSC class-based resource

Build & Test Workflow Requirements

• Run PowerShell script files from repository root
• Setup build and test environment (once per pwsh session): ./build.ps1 -Tasks noop
• Build project before running tests: ./build.ps1 -Tasks build
• Always run tests in new pwsh session: Invoke-Pester -Path @({test paths}) -Output Detailed

File Organization

• Public commands: source/Public/{CommandName}.ps1
• Private functions: source/Private/{FunctionName}.ps1
• Unit tests: tests/Unit/{Classes|Public|Private}/{Name}.Tests.ps1
• Integration tests: tests/Integration/Commands/{CommandName}.Integration.Tests.ps1

Requirements

• Follow instructions over existing code patterns
• Follow PowerShell style and test guideline instructions strictly
• Always update CHANGELOG.md Unreleased section
• Localize all strings using string keys; remove any orphaned string keys
• Check DscResource.Common before creating private functions
• Separate reusable logic into private functions
• DSC resources should always be created as class-based resources
• Add unit tests for all commands/functions/resources
• Add integration tests for all public commands and resources

Files:

• tests/Integration/Commands/README.md
• CHANGELOG.md

CHANGELOG.md

📄 CodeRabbit inference engine (.github/instructions/dsc-community-style-guidelines-changelog.instructions.md)

CHANGELOG.md: Always update the Unreleased section in CHANGELOG.md
Use Keep a Changelog format
Describe notable changes briefly, with no more than 2 items per change type
Reference issues using the format issue #<issue_number>
No empty lines between list items in the same section
Skip adding an entry if the same change already exists in the Unreleased section
No duplicate sections or items in the Unreleased section

Always update the Unreleased section of CHANGELOG.md

Files:

• CHANGELOG.md

---

⚙️ CodeRabbit configuration file

CHANGELOG.md: # Changelog Guidelines

• Always update the Unreleased section in CHANGELOG.md
• Use Keep a Changelog format
• Describe notable changes briefly, ≤2 items per change type
• Reference issues using format issue #<issue_number>
• No empty lines between list items in same section
• Skip adding entry if same change already exists in Unreleased section
• No duplicate sections or items in Unreleased section

Files:

• CHANGELOG.md

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)

• GitHub Check: dsccommunity.SqlServerDsc (Build Package Module)
• GitHub Check: PSScriptAnalyzer
• GitHub Check: PSScriptAnalyzer

🔇 Additional comments (2)

CHANGELOG.md (1)

48-50: LGTM: rewrap/readability tweak is fine.

Entry remains consistent with existing Added items and issue link format.

tests/Integration/Commands/README.md (1)

84-84: ConvertFrom-SqlDscDatabasePermission integration tests don’t connect to SQL
They only assert properties on the returned DatabasePermissionSet and contain no Connect-SqlDscDatabaseEngine calls.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94%. Comparing base (4143879) to head (06124e6).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@         Coverage Diff          @@
##           main   #2298   +/-   ##
====================================
  Coverage    94%     94%           
====================================
  Files       150     150           
  Lines      9236    9236           
====================================
  Hits       8748    8748           
  Misses      488     488           

Flag	Coverage Δ
unit	94% <ø> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.