How to generate Microsoft DSC adapted resource manifests with DscResource.Authoring#252
Open
Gijsreyn wants to merge 2 commits into
Open
How to generate Microsoft DSC adapted resource manifests with DscResource.Authoring#252Gijsreyn wants to merge 2 commits into
DscResource.Authoring#252Gijsreyn wants to merge 2 commits into
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThis PR adds a comprehensive blog post documenting how to generate Microsoft DSC adapted resource manifests using the DscResource.Authoring module. The post progresses from explaining what adapted manifests are and why they matter, through technical details of manifest generation and property customization, to practical automation via build.yaml pipelines. ChangesDSC Adapted Resource Manifests Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 10
🤖 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
`@content/blog/how-to-generate-microsoft-dsc-adapted-resource-manifests-with-dscresource.authoring.md`:
- Around line 143-245: The prose in the
"how-to-generate-microsoft-dsc-adapted-resource-manifests-with-dscresource.authoring.md"
section contains several lines longer than 80 characters; wrap those paragraphs
at word boundaries to max 80 columns, preserving existing sentences and
markdown/code blocks (affecting the paragraphs around the explanation of
New-DscAdaptedResourceManifest, the example module manifest, the JSON snippets,
and the narrative about class inspection). Locate the explanatory text that
references New-DscAdaptedResourceManifest, the WinGetPackage class example, and
the JSON schema blocks (these are the unique anchors) and reflow the long lines
into multiple shorter lines without changing wording or content structure,
ensuring code fences remain intact.
- Around line 418-429: Several prose lines in the markdown (mentions like
"DscResource.Authoring", "build.yaml", and the numbered short version steps)
exceed the 80-character line-length rule; reflow those sentences so each line
wraps at or before 80 characters at word boundaries (preserve words,
punctuation, Markdown list formatting and links), update lines that reference
the two tasks and the short version steps so they remain readable and
semantically identical, and ensure the changed lines (previously around the
statements about generating the manifest and shipping adapted resource
manifests) keep the same content but are split into multiple shorter lines.
- Around line 249-341: Several prose lines in the article exceed the
80-character wrap guideline; reflow the paragraph text so lines wrap at word
boundaries to <=80 characters (not code blocks). Edit the narrative around the
New-DscAdaptedResourceManifest example and the paragraphs mentioning
New-DscPropertyOverride, Update-DscAdaptedResourceManifest, and ToJson to break
long sentences into shorter lines (preserving words and punctuation) so the
lines that currently exceed 80 characters (around the example block and final
paragraphs) are wrapped to comply with the style guide.
- Around line 21-136: Several prose lines in the blog post exceed the
80-character limit (notably the opening paragraph that starts "Adapted resource
manifests slowly started emerging..." and later descriptive paragraphs around
the JSON example, YAML snippet, and image captions), so reflow those paragraphs
to wrap at word boundaries to 80 characters or less; update the long sentences
surrounding the JSON example block, the YAML example block, and the
image-caption paragraphs (references to the WinGet examples and
discovery/process descriptions) so each line is ≤80 chars while preserving
wording and code block formatting.
- Around line 345-402: The prose in the markdown (around the opening paragraph
that starts "Each DSC community module contains a `build.yaml`." and the later
paragraph that begins "Through the `build.yaml` file, you can always apply
customizations.") has lines exceeding 80 characters; reflow those sentences to
wrap at 80-character word boundaries (do not alter code blocks or YAML snippet,
image reference, or inline code tokens like
`Create_DscAdaptedResourceManifests`/`Create_DscResourceManifestsList`/`BuildWorkflow`/`SqlServerDsc`),
preserving existing Markdown structure and line breaks only in the long prose
lines.
- Line 425: Fix the typo in the sentence "Choice one of the two tasks exposed
from `DscResource.Authoring`" by replacing the word "Choice" with "Choose" so
the line reads "Choose one of the two tasks exposed from
`DscResource.Authoring`"; locate and update that exact string in the Markdown
content (the sentence containing `DscResource.Authoring`) to apply the
correction.
- Around line 347-348: The ordered list items for
"Create_DscAdaptedResourceManifests" and "Create_DscResourceManifestsList" must
use the 1/1/1 numbering style; update the two list lines so both begin with "1."
(i.e., replace the current "1." and "2." prefixes so each item is numbered "1.")
while keeping the item text and backticks intact.
- Around line 424-427: The ordered list under the steps beginning with "Open the
`build.yaml`" currently uses sequential numbers (1,2,3,4); update each list item
so they all use "1." (1. Open the `build.yaml`, 1. Choice one..., 1. Add one of
them, 1. Generate the manifest...) to follow the required 1/1/1 numbering style;
ensure spacing and punctuation remain consistent and that the Markdown renderer
still treats it as a single ordered list.
- Around line 9-17: Reflow the Markdown prose so no line exceeds 80 characters:
wrap the long sentences on lines containing "Class-based DSC resources are the
way forward. Period.", "Whilst there are a ton of script-based DSC resources
available in this community, slowly, more class-based start to appear.", "Now,
with Microsoft DSC, two new features were launched during release v3.2: resource
discovery and optimizing the execution have become more explicit.", "That leaves
maintainers of the current class-based resources with a question: should every
existing class-based resource now have a hand-written manifest too?", and the
paragraph starting "The goal of the newly introduced `DscResource.Authoring`
module..."; break at word boundaries to <=80 chars per line, preserve inline
code like `Export` and `DscResource.Authoring`, and keep original sentence/order
and Markdown paragraph structure.
- Line 432: The reference line containing the long URL to the SqlServerDsc class
file (the markdown reference link "[00]:
https://github.com/dsccommunity/SqlServerDsc/blob/main/source/Classes/020.SqlAudit.ps1")
exceeds 80 characters; wrap this reference at word boundaries so no line is
longer than 80 chars (for example split the URL across two lines using Markdown
concatenation or break the reference into a shorter label and place the full URL
on the next wrapped line) and ensure the link remains valid in the rendered
markdown.
🪄 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: 9d91cbd0-b5d0-4bad-b878-361add717f83
⛔ Files ignored due to path filters (5)
static/images/discover-dsc-resources-process.pngis excluded by!**/*.pngstatic/images/dsc-generate-adapted-manifest-winget.pngis excluded by!**/*.pngstatic/images/dsc-sqlserver-adapted-manifests.pngis excluded by!**/*.pngstatic/images/dsc-with-adapted-resource-manifest.pngis excluded by!**/*.pngstatic/images/dsc-without-adapted-resource-manifest.pngis excluded by!**/*.png
📒 Files selected for processing (1)
content/blog/how-to-generate-microsoft-dsc-adapted-resource-manifests-with-dscresource.authoring.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request adds a new blog post called "How to generate Microsoft DSC adapted resource manifests with DscResource.Authoring". It focuses on explaining the new
DscResource.Authoringand how existing resource authors can easily use it in theirbuild.yamlfile(s).This change is