mirror of
https://github.com/PowerShell/PSDesiredStateConfiguration
synced 2026-06-21 13:45:25 +00:00
Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 8249681ba9 | |||
| 8daa912f90 | |||
| 025d75fa4b | |||
| 04830ef480 | |||
| 805041c8fe | |||
| 62d16f9563 | |||
| a201b69203 | |||
| 2eb60a3b42 |
@@ -1,71 +1,77 @@
|
||||
name: Bug report 🐛
|
||||
description: Report errors or unexpected behavior 🤔
|
||||
labels: Needs-Triage
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: >
|
||||
For Windows PowerShell 5.1 DSC issues, suggestions, or feature requests please use the
|
||||
[Feedback Hub app](https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332)
|
||||
|
||||
This repository is **ONLY** for PSDesiredStateConfiguration module available on PowerShellGallery.com
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Prerequisites
|
||||
options:
|
||||
- label: Write a descriptive title.
|
||||
required: true
|
||||
- label: Make sure you are able to repro it on the [latest released version](https://www.powershellgallery.com/packages/PSDesiredStateConfiguration)
|
||||
required: true
|
||||
- label: Search the existing issues.
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: >
|
||||
List of steps, sample code, failing test or link to a project that reproduces the behavior.
|
||||
Make sure you place a stack trace inside a code (```) block to avoid linking unrelated issues.
|
||||
placeholder: >
|
||||
I am experiencing a problem with X.
|
||||
I think Y should be happening but Z is actually happening.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
render: console
|
||||
placeholder: |
|
||||
PS> 2 + 2
|
||||
4
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Actual behavior
|
||||
render: console
|
||||
placeholder: |
|
||||
PS> 2 + 2
|
||||
5
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Error details
|
||||
description: Paste verbatim output from `Get-Error` if PSDesiredStateConfiguration cmdlet return an error.
|
||||
render: console
|
||||
placeholder: PS> Get-Error
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Environment data
|
||||
description: Paste verbatim output from `$PSVersionTable` below as well as PSDesiredStateConfiguration module info
|
||||
render: powershell
|
||||
placeholder: PS> $PSVersionTable; Get-Module PSDesiredStateConfiguration
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Visuals
|
||||
description: >
|
||||
Please upload images or animations that can be used to reproduce issues in the area below.
|
||||
Try the [Steps Recorder](https://support.microsoft.com/en-us/windows/record-steps-to-reproduce-a-problem-46582a9b-620f-2e36-00c9-04e25d784e47)
|
||||
on Windows or [Screenshot](https://support.apple.com/en-us/HT208721) on macOS.
|
||||
name: Bug report 🐛
|
||||
description: Report errors or unexpected behavior 🤔
|
||||
labels:
|
||||
- bug
|
||||
- Needs-Triage
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: >-
|
||||
This repository is **ONLY** for issues related to DSC in the published
|
||||
PSDesiredStateConfiguration module.
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Prerequisites
|
||||
options:
|
||||
- label: Write a descriptive title.
|
||||
required: true
|
||||
- label: Make sure you are able to repro it on the [latest released version](https://www.powershellgallery.com/packages/PSDesiredStateConfiguration)
|
||||
required: true
|
||||
- label: Search the existing issues.
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: >
|
||||
List of steps, sample code, failing test or link to a project that reproduces the behavior.
|
||||
Make sure you place a stack trace inside a code (```) block to avoid linking unrelated issues.
|
||||
placeholder: >
|
||||
I am experiencing a problem with X.
|
||||
I think Y should be happening but Z is actually happening.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
render: console
|
||||
placeholder: |
|
||||
PS> 2 + 2
|
||||
4
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Actual behavior
|
||||
render: console
|
||||
placeholder: |
|
||||
PS> 2 + 2
|
||||
5
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Error details
|
||||
description: Paste verbatim output from `Get-Error` if PowerShell returns an error.
|
||||
render: console
|
||||
placeholder: PS> Get-Error
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Environment data
|
||||
description: Paste verbatim output from `$PSVersionTable` below.
|
||||
render: PowerShell
|
||||
placeholder: PS> $PSVersionTable
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
validations:
|
||||
required: true
|
||||
attributes:
|
||||
label: Version
|
||||
description: Specify the version of Crescendo you are using.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Visuals
|
||||
description: >
|
||||
Please upload images or animations that can be used to reproduce issues in the area below.
|
||||
Try the [Steps Recorder](https://support.microsoft.com/en-us/windows/record-steps-to-reproduce-a-problem-46582a9b-620f-2e36-00c9-04e25d784e47)
|
||||
on Windows or [Screenshot](https://support.apple.com/en-us/HT208721) on macOS.
|
||||
|
||||
@@ -1,20 +1,23 @@
|
||||
name: Feature Request / Idea 🚀
|
||||
description: Suggest a new feature or improvement (this does not mean you have to implement it)
|
||||
labels: [Issue-Enhancement, Needs-Triage]
|
||||
body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Summary of the new feature / enhancement
|
||||
description: >
|
||||
A clear and concise description of what the problem is that the
|
||||
new feature would solve. Try formulating it in user story style
|
||||
(if applicable).
|
||||
placeholder: "'As a user I want X so that Y...' with X being the being the action and Y being the value of the action."
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Proposed technical implementation details (optional)
|
||||
placeholder: >
|
||||
A clear and concise description of what you want to happen.
|
||||
Consider providing an example PowerShell script experience with expected result.
|
||||
name: Feature Request / Idea 🚀
|
||||
description: Suggest a new feature or improvement (this does not mean you have to implement it)
|
||||
labels:
|
||||
- enhancement
|
||||
- Needs-Triage
|
||||
body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Summary of the new feature / enhancement
|
||||
description: >
|
||||
A clear and concise description of what the problem is that the new feature would solve. Try
|
||||
formulating it in user story style (if applicable).
|
||||
placeholder: >
|
||||
'As a user I want X so that Y...' with X being the being the action and Y being the value of
|
||||
the action.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Proposed technical implementation details (optional)
|
||||
placeholder: >
|
||||
A clear and concise description of what you want to happen. Consider providing an example
|
||||
experience with expected result.
|
||||
|
||||
@@ -1,5 +1,17 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: Documentation Issue
|
||||
url: https://github.com/MicrosoftDocs/PowerShell-Docs-DSC
|
||||
about: Please open issues on documentation for PSDesiredStateConfiguration here.
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: PowerShell Issues
|
||||
url: https://github.com/PowerShell/PowerShell/issues/new
|
||||
about: PowerShell issues or suggestions.
|
||||
- name: Windows PowerShell Issues
|
||||
url: https://support.microsoft.com/windows/send-feedback-to-microsoft-with-the-feedback-hub-app-f59187f8-8739-22d6-ba93-f66612949332
|
||||
about: Windows PowerShell issues or suggestions.
|
||||
- name: Support
|
||||
url: https://github.com/PowerShell/PowerShell/blob/master/.github/SUPPORT.md
|
||||
about: PowerShell Support Questions/Help
|
||||
- name: Documentation Issue
|
||||
url: https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/issues/new/choose
|
||||
about: Please open issues on documentation for DSC here.
|
||||
- name: Azure Policy Feedback
|
||||
about: File feedback for Azure Policy's machine configuration feature
|
||||
url: https://feedback.azure.com/d365community/forum/675ae472-f324-ec11-b6e6-000d3a4f0da0
|
||||
|
||||
@@ -9,13 +9,19 @@ resources:
|
||||
endpoint: ComplianceGHRepo
|
||||
name: PowerShell/compliance
|
||||
|
||||
variables:
|
||||
- name: PackageName
|
||||
value: 'PSDesiredStateConfiguration'
|
||||
- name: PackageVersion
|
||||
value: '3.0.0'
|
||||
|
||||
stages:
|
||||
- stage: Build
|
||||
displayName: Build PSDesiredStateConfiguration module
|
||||
pool:
|
||||
name: 1ES
|
||||
demands:
|
||||
- ImageOverride -equals MMS2019
|
||||
- ImageOverride -equals PSMMS2019-Secure
|
||||
jobs:
|
||||
- job: BuildPkg
|
||||
displayName: Build Package
|
||||
@@ -115,6 +121,13 @@ stages:
|
||||
# the file pattern to use, comma separated
|
||||
pattern: '*.psm1,*.psd1,Microsoft.PowerShell.DscSubsystem.dll'
|
||||
|
||||
- template: Sbom.yml@ComplianceRepo
|
||||
parameters:
|
||||
BuildDropPath: "$(Build.SourcesDirectory)/signed/PSDesiredStateConfiguration/PSDesiredStateConfiguration"
|
||||
Build_Repository_Uri: 'https://github.com/PowerShell/PSDesiredStateConfiguration'
|
||||
PackageName: $(PackageName)
|
||||
PackageVersion: $(PackageVersion)
|
||||
|
||||
- pwsh: |
|
||||
$repoName = [guid]::newGuid().ToString("N")
|
||||
$packageRoot = "$(Build.SourcesDirectory)\signed\PSDesiredStateConfiguration"
|
||||
|
||||
@@ -0,0 +1,3 @@
|
||||
# Changelogs
|
||||
|
||||
* [v2 changelog](v2.md)
|
||||
@@ -0,0 +1,15 @@
|
||||
# v2 Changelog
|
||||
|
||||
## [v2.0.6]
|
||||
|
||||
### Main changes
|
||||
|
||||
- Fixed `PathSeparator` bug in Get-DSCResourceModules.
|
||||
- Changed `PSDesiredStateConfiguration.InvokeDscResource` from experimental to permanently enabled feature.
|
||||
- Changed `ErrorAction` to `Ignore` so that the error doesn't show up in `$Error`.
|
||||
- Removed duplicate result resources from `Get-DSCResourcesModules`.
|
||||
- Add `ImplementationDetail` member to results only when the member does not already exist.
|
||||
- Updated v2 Release pipeline with latest Compliance requirements.
|
||||
- Added SBOM generation that is now released with v2 module.
|
||||
|
||||
[v2.0.6]: https://www.powershellgallery.com/packages/PSDesiredStateConfiguration/2.0.6
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2022 PowerShell Team
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@@ -1,5 +1,46 @@
|
||||
# PSDesiredStateConfiguration module
|
||||
|
||||
**NOTE: We are currently NOT accepting PRs for this project**
|
||||
|
||||
**PSDesiredStateConfiguration** (DSC) is the PowerShell module that enables writing configuration as code.
|
||||
|
||||
The DSC platform was originally built on top of WMI for Windows. Starting in PowerShell 7.1 and working
|
||||
with internal partner teams
|
||||
[Azure Guest Configuration](https://docs.microsoft.com/azure/governance/policy/concepts/guest-configuration)
|
||||
and [Automanage](https://azure.microsoft.com/services/azure-automanage), we started making
|
||||
DSC cross-platform by enabling `Invoke-DSCResource` to directly use resources without going through
|
||||
the Local Configuration Manager (LCM).
|
||||
|
||||
Our initial cross-platform work to enable partner teams:
|
||||
|
||||
- Separated out the DSC parts in the PowerShell engine and moved them as a subsystem into the
|
||||
PSDesiredStateConfiguration module
|
||||
- Remove PSDesiredStateConfiguration module from the PowerShell 7 package. This allows the
|
||||
PSDesiredStateConfiguration module to be developed independently of PowerShell and users can mix
|
||||
and match versions of PowerShell and PSDesiredStateConfiguration for their environment.
|
||||
- This is now available on the PowerShell Gallery: [PSDesiredStateConfiguration 2.x](https://www.powershellgallery.com/packages/PSDesiredStateConfiguration)
|
||||
- Removing the dependency on MOF: Initially, only support DSC Resources written as PowerShell
|
||||
classes. This includes tooling to convert existing script based DSC Resources to be wrapped as
|
||||
PowerShell classes.
|
||||
|
||||
## Documentation and resources
|
||||
|
||||
The documentation for **PSDesiredStateConfiguration** 3.0.0-beta1 is a work-in-progress. We invite the
|
||||
community to review the documentation and assist us as we work on new documentation during the platform
|
||||
development.
|
||||
|
||||
For more information about DSC v3, see [PowerShell Desired State Configuration Overview](https://docs.microsoft.com/powershell/dsc/overview?view=dsc-3.0)
|
||||
|
||||
To download the latest release from the PowerShell Gallery, see [PSDesiredStateConfiguration 3.0.0-beta1](https://www.powershellgallery.com/packages/PSDesiredStateConfiguration/3.0.0-beta1)
|
||||
|
||||
## Community Feedback
|
||||
|
||||
As we continue this journey to make DSC a cross-platform technology, we invite the community to
|
||||
share your ideas and open
|
||||
[issues](https://github.com/PowerShell/PSDesiredStateConfiguration/issues). During the PowerShell
|
||||
7.3 timeframe, we remain focused on enabling partner teams and will not be accepting public pull
|
||||
requests.
|
||||
|
||||
## Build
|
||||
|
||||
### Requirements
|
||||
|
||||
@@ -71,7 +71,7 @@ data LocalizedData
|
||||
Set-StrictMode -Off
|
||||
|
||||
# In case localized resource is not available we revert back to English as defined in LocalizedData section so ignore the error instead of showing it to user.
|
||||
Import-LocalizedData -BindingVariable LocalizedData -FileName PSDesiredStateConfiguration.Resource.psd1 -ErrorAction SilentlyContinue
|
||||
Import-LocalizedData -BindingVariable LocalizedData -FileName PSDesiredStateConfiguration.Resource.psd1 -ErrorAction Ignore
|
||||
|
||||
Import-Module $PSScriptRoot/helpers/DscResourceInfo.psm1
|
||||
|
||||
@@ -3481,7 +3481,7 @@ function New-DscChecksum
|
||||
}
|
||||
|
||||
# If the Force parameter was not specified and the hash file already exists for the current file, log this, and skip this file
|
||||
if (!$Force -and (Get-Item -Path $fileOutpath -ErrorAction SilentlyContinue))
|
||||
if (!$Force -and (Get-Item -Path $fileOutpath -ErrorAction Ignore))
|
||||
{
|
||||
Write-Log -Message ($LocalizedData.CheckSumFileExists -f $fileOutpath)
|
||||
continue
|
||||
|
||||
Reference in New Issue
Block a user