xPSDesiredStateConfiguration.psd1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
@{
    # Root module
    RootModule        = 'Modules\DscPullServerSetup\DscPullServerSetup.psm1'

    # Version number of this module.
    moduleVersion     = '9.0.0'

    # ID used to uniquely identify this module
    GUID              = 'cc8dc021-fa5f-4f96-8ecf-dfd68a6d9d48'

    # Author of this module
    Author            = 'DSC Community'

    # Company or vendor of this module
    CompanyName       = 'DSC Community'

    # Copyright statement for this module
    Copyright         = 'Copyright the DSC Community contributors. All rights reserved.'

    # Description of the functionality provided by this module
    Description       = 'DSC resources for configuring common operating systems features, files and settings.'

    # Minimum version of the Windows PowerShell engine required by this module
    PowerShellVersion = '4.0'

    # Minimum version of the common language runtime (CLR) required by this module
    CLRVersion        = '4.0'

    # Functions to export from this module
    FunctionsToExport = @()

    # Cmdlets to export from this module
    CmdletsToExport   = @()

    # Variables to export from this module
    VariablesToExport = @()

    # Aliases to export from this module
    AliasesToExport   = @()

    # DSC resources to export from this module
    DscResourcesToExport  = @(
        'xArchive', 'xDSCWebService', 'xEnvironment','xGroup','xMsiPackage',
        'xPackage','xPSEndpoint','xRegistry','xRemoteFile',
        'xScript','xService','xUser','xWindowsFeature','xWindowsOptionalFeature',
        'xWindowsPackageCab','xWindowsProcess'
    )

    # Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
    PrivateData       = @{

        PSData = @{
            # Set to a prerelease string value if the release should be a prerelease.
            Prerelease   = 'preview0003'

            # Tags applied to this module. These help with module discovery in online galleries.
            Tags         = @('DesiredStateConfiguration', 'DSC', 'DSCResourceKit', 'DSCResource')

            # A URL to the license for this module.
            LicenseUri   = 'https://github.com/dsccommunity/xPSDesiredStateConfiguration/blob/master/LICENSE'

            # A URL to the main website for this project.
            ProjectUri   = 'https://github.com/dsccommunity/xPSDesiredStateConfiguration'

            # A URL to an icon representing this module.
            IconUri      = 'https://dsccommunity.org/images/DSC_Logo_300p.png'

            # ReleaseNotes of this module
            ReleaseNotes = '# Change log for xPSDesiredStateConfiguration
 
The format is based on and uses the types of changes according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
## [Unreleased]
 
### Added
 
- xPSDesiredStateConfiguration
  - Added support for Checksum on xRemoteFile - [issue #423](https://github.com/PowerShell/PSDscResources/issues/423)
  - Added `Test-DscParameterState` support function to `xPSDesiredStateConfiguration.Common.psm1`.
  - Added standard unit tests for `xPSDesiredStateConfiguration.Common.psm1`.
  - Added automatic release with a new CI pipeline.
 
### Changed
 
- xPSDesiredStateConfiguration
  - PublishModulesAndMofsToPullServer.psm1:
    - Fixes issue in Publish-MOFToPullServer that incorrectly tries to create a
      new MOF file instead of reading the existing one.
      [issue #575](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/575)
  - Fix minor style issues with missing spaces between `param` statements and ''(''.
  - MSFT_xDSCWebService:
    - Removal of commented out code.
    - Updated to meet HQRM style guidelines - Fixes [issue #623](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/623)
    - Added MOF descriptions.
  - Corrected minor style issues.
  - Fix minor style issues in hashtable layout.
  - Shared modules moved to `source/Module` folder and renamed:
    - `CommonResourceHelper.psm1` -> `xPSDesiredStateConfiguration.Common.psm1`
  - Moved functions from `ResourceSetHelper.psm1` into
    `xPSDesiredStateConfiguration.Common.psm1`.
  - BREAKING CHANGE: Changed resource prefix from MSFT to DSC.
  - Pinned `ModuleBuilder` to v1.0.0.
  - Updated build badges in README.MD.
  - Remove unused localization strings.
  - Adopt DSC Community Code of Conduct.
  - DSC_xPSSessionConfiguration:
    - Moved strings to localization file.
  - DSC_xScriptResource
    - Updated parameter descriptions to match MOF file.
  - Correct miscellaneous style issues.
  - DSC_xWindowsOptionalFeature
    - Fix localization strings.
  - DSC_xEnvironmentResource
    - Remove unused localization strings.
  - DSC_xRemoteFile
    - Updated end-to-end tests to use the same pattern as the other end-to-end
      tests in this module.
  - DSC_xDSCWebService
    - Moved `PSWSIISEndpoint.psm1` module into `xPSDesiredStateConfiguration.PSWSIIS`.
    - Moved `Firewall.psm1` module into `xPSDesiredStateConfiguration.Firewall`.
    - Moved `SecureTLSProtocols.psm1` and `UseSecurityBestPractices.psm1` module
      into `xPSDesiredStateConfiguration.Security`.
    - Fix issue with `Get-TargetResource` when a DSC Pull Server website is not
      installed.
  - DSC_xWindowsFeature
    - Changed tests to be able to run on machines without `*-WindowsFeature` cmdlets.
    - Changed `Assert-SingleInstanceOfFeature` to accept an array.
  - BREAKING CHANGE: Renamed `PublishModulesAndMofsToPullServer` module to
    `DscPullServerSetup` and moved to Modules folder.
  - Moved test helper modules into `tests\TestHelpers` folder.
- DSCPullServerSetup
  - Fixed markdown errors in README.MD.
  - Moved strings to Localization file.
  - Corrected style violations.
- Updated build badges to reflect correct Azure DevOps build Definition Id - fixes
  [issue #656](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/656).
- Set `testRunTitle` for PublishTestResults steps so that a helpful name is
  displayed in Azure DevOps for each test run.
- Set a display name on all the jobs and tasks in the CI
  pipeline - fixes [issue #663](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/663).
 
### Deprecated
 
- None
 
### Removed
 
- xPSDesiredStateConfiguration
  - Removed files no longer required by new CI process.
 
### Fixed
 
- MSFT_xRegistryResource
  - Fixes issue that the `Set-TargetResource` does not determine
    the type of registry value correctly.
    [issue #436](https://github.com/dsccommunity/xPSDesiredStateConfiguration/issues/436)
- Fixed Pull Server example links in `README.MD` - fixes
  [issue #659](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/659).
- Fixed `GitVersion.yml` feature and fix Regex - fixes
  [issue #660](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/660).
- Fix import statement in all tests, making sure it throws if module
  DscResource.Test cannot be imported - fixes
  [issue #666](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/666).
- Fix deploy stage in CI pipeline to prevent it executing against forks
  of the repository - fixes [issue #665](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/665).
- Fix deploy fork detection in CI pipeline - fixes [issue #668](https://github.com/PowerShell/xPSDesiredStateConfiguration/issues/668).
 
### Security
 
- None
'

        } # End of PSData hashtable
    } # End of PrivateData hashtable
}