Skip to content

feat: Add adapted resource manifest generation - #2461

Merged
johlju merged 4 commits into
dsccommunity:mainfrom
Gijsreyn:add-adapted-resourcegen
Jul 11, 2026
Merged

feat: Add adapted resource manifest generation#2461
johlju merged 4 commits into
dsccommunity:mainfrom
Gijsreyn:add-adapted-resourcegen

Conversation

@Gijsreyn

@Gijsreyn Gijsreyn commented May 14, 2026

Copy link
Copy Markdown
Contributor

Pull Request (PR) description

This pull request adds a new task to create an adapted resource manifest (*.dsc.manifests.json) after the build succeeds. This adapted manifest can be shipped alongside the module, so that Microsoft's DSC engine can find it using the PowerShell discovery extension.

Note

For more information on the working, check out the excellent Wiki docs.

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

@Gijsreyn
Gijsreyn requested a review from johlju as a code owner May 14, 2026 08:44
@coderabbitai

coderabbitai Bot commented May 14, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c9beb647-d356-43da-899a-1364adf56f12

📥 Commits

Reviewing files that changed from the base of the PR and between 2f194f4 and 1f5c1e1.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • RequiredModules.psd1
  • build.yaml
✅ Files skipped from review due to trivial changes (3)
  • RequiredModules.psd1
  • CHANGELOG.md
  • build.yaml

Walkthrough

Adds DscResource.Authoring as a required module, runs adapted resource manifest generation in the build pipeline, and documents the change in CHANGELOG.md.

Changes

Build Configuration

Layer / File(s) Summary
Module dependency for adapted resource manifests
RequiredModules.psd1
Declares DscResource.Authoring with Version = 'latest' and prerelease versions allowed.
Build pipeline integration and release notes
build.yaml, CHANGELOG.md
Adds the authoring task configuration, runs Create_DscAdaptedResourceManifests after Create_Changelog_Release_Output, and documents the capability under Unreleased.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding adapted resource manifest generation.
Description check ✅ Passed The description directly explains the manifest generation task and matches the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@build.yaml`:
- Line 15: The build references a missing Invoke-Build task named
Create_DscResourceManifestsList which causes invocation to fail; either remove
the Create_DscResourceManifestsList entry from the build workflow or add a
corresponding task definition in an *.ib.tasks file (and export it from the
DscResource.Authoring module if required) so Invoke-Build can discover it—update
the build.yaml workflow to no longer call Create_DscResourceManifestsList if you
remove the task, or create a properly named Create_DscResourceManifestsList task
implementation and ensure it is exported/imported where tasks are loaded.

In `@CHANGELOG.md`:
- Around line 10-11: Update the Unreleased CHANGELOG.md entry for "SqlServerDsc"
by appending the related issue reference in the required Markdown format; modify
the entry "- Added adapted resource manifest generation to the build pipeline."
to include the issue link like "([issue
#<number>](https://github.com/dsccommunity/SqlServerDsc/issues/<number>))" so
the line reads with the issue reference at the end.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a0757a1e-b725-48f4-b004-5c68063bd711

📥 Commits

Reviewing files that changed from the base of the PR and between 9fbc7a5 and 5c69b03.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • RequiredModules.psd1
  • build.yaml

Comment thread build.yaml Outdated
Comment thread CHANGELOG.md
@codecov

codecov Bot commented May 14, 2026

Copy link
Copy Markdown

Codecov Report

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

Additional details and impacted files

Impacted file tree graph

@@          Coverage Diff          @@
##            main   #2461   +/-   ##
=====================================
- Coverage     94%     94%   -1%     
=====================================
  Files        227     227           
  Lines      10871   10871           
=====================================
- Hits       10235   10234    -1     
- Misses       636     637    +1     
Flag Coverage Δ
unit 94% <ø> (-1%) ⬇️
see 1 file with indirect coverage changes
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions

Copy link
Copy Markdown

Labeling this pull request (PR) as abandoned since it has gone 14 days or more since the last update. An abandoned PR can be continued by another contributor. The abandoned label will be removed if work on this PR is taken up again.

@github-actions github-actions Bot added the abandoned The pull request has been abandoned. label May 29, 2026
@johlju johlju added needs review The pull request needs a code review. and removed abandoned The pull request has been abandoned. labels Jun 4, 2026
@johlju

johlju commented Jun 4, 2026

Copy link
Copy Markdown
Member

Will get to this. Just a lot of stuff at work and private 🙂 But haven't forgotten.

@Gijsreyn
Gijsreyn force-pushed the add-adapted-resourcegen branch from 2f194f4 to 1f5c1e1 Compare July 11, 2026 04:58

@johlju johlju left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

:lgtm:

@johlju reviewed 3 files and all commit messages, and made 1 comment.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on Gijsreyn).

@johlju
johlju merged commit e5b53bb into dsccommunity:main Jul 11, 2026
40 checks passed
@johlju johlju removed the needs review The pull request needs a code review. label Jul 11, 2026
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.

2 participants