Skip to content

Update deprecated config key#786

Open
dan-hughes wants to merge 7 commits intodsccommunity:mainfrom
dan-hughes:fix/784
Open

Update deprecated config key#786
dan-hughes wants to merge 7 commits intodsccommunity:mainfrom
dan-hughes:fix/784

Conversation

@dan-hughes
Copy link
Copy Markdown
Contributor

@dan-hughes dan-hughes commented Mar 26, 2026

Pull Request (PR) description

Fix warning on Generate_Wiki_Content.
Update docs task to use latest tasks.
Add WikiContent to GitHub release assets.

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 added/updated in README.md.
  • Resource parameter descriptions added/updated in README.md, schema.mof
    and comment-based help.
  • Comment-based help added/updated.
  • Localization strings added/updated in all localization files as appropriate.
  • Examples appropriately added/updated.
  • Unit tests added/updated. See DSC Community Testing Guidelines.
  • Integration tests added/updated (where possible). See DSC Community Testing Guidelines.
  • New/changed code adheres to DSC Community Style Guidelines.

This change is Reviewable

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 26, 2026

Warning

Rate limit exceeded

@dan-hughes has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 21 minutes and 42 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 21 minutes and 42 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 24a0a12a-430b-4238-8859-e6370cc6b037

📥 Commits

Reviewing files that changed from the base of the PR and between 5a78d70 and 1fad251.

📒 Files selected for processing (1)
  • build.yaml

Walkthrough

Simplifies the docs build workflow by removing several command-related generation steps, renames the DSC wiki generation key from Generate_Wiki_Content to Generate_Markdown_For_DSC_Resources, adds a Package_Wiki_Content step and release asset, updates the PowerShell Gallery badge in the README, and documents changes in CHANGELOG.md.

Changes

Cohort / File(s) Summary
Changelog Updates
CHANGELOG.md
Added an Unreleased ### Changed entry noting DocGeneration updates and a ### Fixed entry for "Update generate markdown config key" (Issue #784).
Build Workflow Configuration
build.yaml
Removed command-related doc generation tasks (Generate_Markdown_For_Public_Commands, Generate_External_Help_File_For_Public_Commands, Clean_Markdown_Of_Public_Commands, Add_newline_to_helpxml), replaced Generate_Wiki_Content with Generate_Markdown_For_DSC_Resources in the DscResource.DocGenerator block, added Package_Wiki_Content to docs workflow, and added GitHubConfig.ReleaseAssets: ['output/WikiContent.zip'].
README Badge
README.md
Updated PowerShell Gallery badge URL to use the non-vpre endpoint and added include_prereleases parameter.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant CI as CI Build (build.yaml)
    participant DocGen as DocGenerator (DscResource)
    participant Pack as Packager
    participant GH as GitHub Release

    Dev->>CI: Push changes (build.yaml, README, CHANGELOG)
    CI->>DocGen: Run Generate_Markdown_For_DSC_Resources
    DocGen-->>CI: Generated wiki markdown
    CI->>Pack: Package_Wiki_Content -> create output/WikiContent.zip
    Pack-->>CI: WikiContent.zip
    CI->>GH: Upload Release Asset (output/WikiContent.zip)
    GH-->>Dev: Release asset available
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Update deprecated config key' directly relates to the main change of replacing the deprecated Generate_Wiki_Content key with Generate_Markdown_For_DSC_Resources in build.yaml.
Description check ✅ Passed The description appropriately documents the changes: fixing the Generate_Wiki_Content warning, updating docs tasks, and adding WikiContent to release assets, all aligned with the changeset.
Linked Issues check ✅ Passed The PR successfully addresses issue #784 by renaming the Generate_Wiki_Content key to Generate_Markdown_For_DSC_Resources in build.yaml, directly resolving the deprecated key usage issue.
Out of Scope Changes check ✅ Passed Changes include necessary updates to CHANGELOG.md and README.md alongside the primary config key rename. The WikiContent.zip release asset addition and docs workflow simplification are reasonable supporting changes to the main objective.
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

🧹 Nitpick comments (1)
CHANGELOG.md (1)

17-17: Consider adding a component prefix for consistency.

Other entries in the ### Fixed section use a component/resource name prefix (e.g., xPSDesiredStateConfiguration.Security). This entry could follow the same pattern for consistency.

📝 Suggested format
-- Update generate markdown config key [Issue `#784`](https://github.com/dsccommunity/xPSDesiredStateConfiguration/issues/784).
+- xPSDesiredStateConfiguration
+  - Update generate markdown config key [Issue `#784`](https://github.com/dsccommunity/xPSDesiredStateConfiguration/issues/784).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@CHANGELOG.md` at line 17, The changelog entry "Update generate markdown
config key [Issue `#784`]" should include the component prefix for consistency
with other entries; update that line to add the package/component prefix (e.g.,
"xPSDesiredStateConfiguration.GenerateMarkdown" or
"xPSDesiredStateConfiguration.Configuration") before the message so it matches
the `### Fixed` section style used by other entries.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@build.yaml`:
- Around line 39-45: Remove the duplicated Generate_Wiki_Content entry from the
docs task list and replace all remaining occurrences of the deprecated
Generate_Wiki_Content task name with the current name
Generate_Markdown_For_DSC_Resources so the docs workflow matches the
DscResource.DocGenerator configuration; specifically edit the docs array that
currently contains two Generate_Wiki_Content entries to keep a single,
correctly-named Generate_Markdown_For_DSC_Resources entry and ensure subsequent
steps still reference the updated name.

---

Nitpick comments:
In `@CHANGELOG.md`:
- Line 17: The changelog entry "Update generate markdown config key [Issue
`#784`]" should include the component prefix for consistency with other entries;
update that line to add the package/component prefix (e.g.,
"xPSDesiredStateConfiguration.GenerateMarkdown" or
"xPSDesiredStateConfiguration.Configuration") before the message so it matches
the `### Fixed` section style used by other entries.
🪄 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: 1ba62005-9794-4c5e-9a2b-37c90e930a3a

📥 Commits

Reviewing files that changed from the base of the PR and between 8fc1c37 and 5fea916.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • build.yaml

@dan-hughes dan-hughes marked this pull request as draft March 27, 2026 11:46
@dan-hughes dan-hughes marked this pull request as ready for review March 27, 2026 11:46
@dan-hughes
Copy link
Copy Markdown
Contributor Author

@johlju

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.

build.yml - Key Generate_Wiki_Content should be replaced with Generate_Markdown_For_DSC_Resources

1 participant