Skip to content

Fixed badge URL#2438

Merged
johlju merged 2 commits intodsccommunity:mainfrom
Xylphy:badge_fix
Jan 27, 2026
Merged

Fixed badge URL#2438
johlju merged 2 commits intodsccommunity:mainfrom
Xylphy:badge_fix

Conversation

@Xylphy
Copy link
Copy Markdown
Contributor

@Xylphy Xylphy commented Jan 26, 2026

Pull Request (PR) description

This PR fixes the PowerShell Gallery badge in SqlServerDsc/README.md so that
prerelease versions are correctly displayed using the supported shields.io
parameters.

No functional or behavioral changes.

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 Reviewable

@Xylphy Xylphy requested a review from johlju as a code owner January 26, 2026 23:18
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 26, 2026

Walkthrough

This pull request updates the PowerShell Gallery badge URL in README.md to correctly display pre-release versions by replacing the vpre parameter with include_prereleases, and documents the fix in CHANGELOG.md.

Changes

Cohort / File(s) Summary
Documentation Updates
CHANGELOG.md, README.md
Updated PowerShell Gallery badge URL from vpre parameter to include_prereleases parameter to properly show preview releases. Added corresponding "Fixed" entry to CHANGELOG.md under Unreleased.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Fixed badge URL' is vague and generic, lacking specificity about which badge was fixed or which project it relates to. Consider using a more descriptive title like 'Fix PowerShell Gallery badge URL for prerelease versions' to better convey the change.
✅ Passed checks (4 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly explains that the PR fixes the PowerShell Gallery badge for prerelease display and references issue #2437, making it directly related to the changeset.
Linked Issues check ✅ Passed The changes directly implement the requirement from issue #2437: updating the badge URL in README.md to use the include_prereleases parameter and updating CHANGELOG.md accordingly.
Out of Scope Changes check ✅ Passed All changes (README.md badge update and CHANGELOG.md entry) are directly scoped to fixing the PowerShell Gallery badge URL as specified in issue #2437.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@CHANGELOG.md`:
- Around line 19-23: Update the Unreleased/Fixed entry for SqlServerDsc: correct
the typo "preleases" to "prereleases", format README.md as inline code
(`README.md`), and append the required issue reference using the repository's
standard issue link format (e.g., "(`#1234`)") so the entry reads clearly and
follows the changelog conventions.
🧹 Nitpick comments (1)
README.md (1)

10-10: Remove trailing space and wrap the long badge line.

The badge line has a trailing space (MD009) and exceeds 80 characters. Consider reference-style links to keep lines within the limit.

🔧 Proposed fix
-[![PowerShell Gallery (with prereleases)](https://img.shields.io/powershellgallery/v/SqlServerDsc?label=SqlServerDsc%20Preview&include_prereleases)](https://www.powershellgallery.com/packages/SqlServerDsc/) 
+[![PowerShell Gallery (with prereleases)][psgallery-preview-badge]][psgallery-preview-link]
+
+[psgallery-preview-badge]: https://img.shields.io/powershellgallery/v/SqlServerDsc?label=SqlServerDsc%20Preview&include_prereleases
+[psgallery-preview-link]: https://www.powershellgallery.com/packages/SqlServerDsc/

Comment thread CHANGELOG.md
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@README.md`:
- Line 10: The markdown line containing the PowerShell Gallery badge
([![PowerShell Gallery (with
prereleases)](https://img.shields.io/powershellgallery/v/SqlServerDsc?label=SqlServerDsc%20Preview&include_prereleases)](https://www.powershellgallery.com/packages/SqlServerDsc/))
has trailing whitespace which violates MD009; remove the trailing space(s) at
the end of that line so the badge link ends immediately after the closing
parenthesis.

Comment thread README.md Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented Jan 27, 2026

Codecov Report

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

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #2438   +/-   ##
=====================================
  Coverage     94%     94%           
=====================================
  Files        225     225           
  Lines      10759   10759           
=====================================
  Hits       10139   10139           
  Misses       620     620           
Flag Coverage Δ
unit 94% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@johlju johlju merged commit 49b5991 into dsccommunity:main Jan 27, 2026
36 checks passed
@johlju
Copy link
Copy Markdown
Member

johlju commented Jan 27, 2026

Thank you! 🙂

@Xylphy Xylphy deleted the badge_fix branch January 27, 2026 12:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix status badge for preview release

2 participants