PowerShell / PowerShell/DSC

Make `Include` resource use more like a composite resource

Open
#585 3 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue-Enhancement
Dominant language
Rust
Stars
523
Forks
75
Avg merge
3d 16h
Merged PRs (30d)
24

Description

Summary of the new feature / enhancement

Currently, if you Include a nested configuration which has parameter, it has to be passed in as a separate file. Instead, we should allow the parameters to be passed in via the parent configuration.

Proposed technical implementation details (optional)

Example of how this could look:

$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
resources:
- name: get os info
  type: Microsoft.DSC/Include
  properties:
    configurationFile: osinfo_parameters.dsc.yaml
    parameters:
      osFamily: macOS

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the Include resource loads a nested configuration and how composite resources receive parameters. Use the YAML example as the expected behavior: parameters supplied in the parent configuration should reach the included configuration without a separate parameter file. Done means this flow works for the shown osFamily value and existing Include behavior remains intact.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
devops
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.