Merge pull request #14 from xoap-io/dev

feat: multiple changes to template

Author: ssokolic

.github/PULL_REQUEST_TEMPLATE.md

@@ -13,8 +13,7 @@
 #### Pull Request (PR) description
 
 <!--
-    Replace this comment block with a description of your PR. Also, make sure you have updated the
-    CHANGELOG.md, see the task list below. An entry in the CHANGELOG.md is mandatory for all PRs.
+    Replace this comment block with a description of your PR.
 -->
 
 #### This Pull Request (PR) fixes the following issues

.github/workflows/megalinter.yaml

@@ -16,19 +16,3 @@ jobs:
         with:
           token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
           fetch-depth: 0
-      - name: MegaLinter
-        id: ml
-        uses: megalinter/megalinter/flavors/[email protected]
-        env:
-          VALIDATE_ALL_CODEBASE: true
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DISABLE: COPYPASTE,SPELL
-          DISABLE_LINTERS: TERRAFORM_TERRASCAN
-      - name: Archive production artifacts
-        if: ${{ success() }} || ${{ failure() }}
-        uses: actions/upload-artifact@v3
-        with:
-          name: MegaLinter reports
-          path: |
-            report
-            mega-linter.log

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/compilerla/conventional-pre-commit
-    rev: v2.3.0
+    rev: v2.4.0
     hooks:
       - id: conventional-pre-commit
         stages: [commit-msg]
@@ -30,11 +30,11 @@ repos:
         args:
           - -b main
   - repo: https://github.com/sirosen/check-jsonschema
-    rev: 0.23.3
+    rev: 0.27.0
     hooks:
       - id: check-github-workflows
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: v3.0.0
+    rev: v3.0.3
     hooks:
       - id: prettier
         stages: [commit]

CHANGELOG.md

@@ -1,15 +1,15 @@
 #
-# Module manifest for module 'Services'
+# Module manifest for module 'XOAP_DSCResource'
 #
-# Generated by: Sinisa Sokolic
+# Generated by: XOAP.io
 #
-# Generated on: 7/25/2023
+# Generated on: 10/11/2023
 #
 
 @{
 
 # Script module or binary module file associated with this manifest.
-RootModule = 'Services.schema.psm1'
+RootModule = 'XOAP_DSCResource.schema.psm1'
 
 # Version number of this module.
 ModuleVersion = '0.0.1'
@@ -21,16 +21,16 @@ ModuleVersion = '0.0.1'
 GUID = '09a6295a-d863-47d9-b8ac-22fedaf9fcfc'
 
 # Author of this module
-Author = 'Sinisa Sokolic'
+Author = 'XOAP.io'
 
 # Company or vendor of this module
 CompanyName = 'RIS AG'
 
 # Copyright statement for this module
-Copyright = '(c) 2023 XOAP. All rights reserved.'
+Copyright = '(c) XOAP.io. All rights reserved.'
 
 # Description of the functionality provided by this module
-Description = 'Configure Windows Services for Azure Virtual Desktop VMs based on Windows 11.'
+Description = 'Short description of the DSC resource.'
 
 # Minimum version of the Windows PowerShell engine required by this module
 PowerShellVersion = '5.1'
@@ -118,7 +118,4 @@ PrivateData = @{
 
 # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
 # DefaultCommandPrefix = ''
-
 }
-
-

DSCResources/Services/Services.schema.psm1

@@ -0,0 +1,16 @@
+configuration 'XOAP_DSCResource'
+{
+
+    Import-DSCResource -ModuleName 'XOAPModuleTemplateDSC' -Name 'XOAP_DSCResource' -ModuleVersion '0.0.1'
+
+    <#
+    Registry disableInsecureCipher_a
+    {
+        Key       = 'HKLM:\SYSTEM\CurrentControlSet\Control\SecurityProviders\SCHANNEL\Ciphers\DES 56/56'
+        ValueName = 'Enabled'
+        ValueData = '0'
+        ValueType = 'Dword'
+        Ensure    = 'Present'
+        Force     = $true
+    }#>
+}

DSCResources/Services/Services.psd1 renamed to DSCResources/XOAP_DSCResource/XOAP_DSCResource.psd1

@@ -0,0 +1,10 @@
+configuration 'XOAPModuleTemplateDSC'
+{
+	Import-DSCResource -Module 'XOAPModuleTemplateDSC' -Name 'XOAP_DSCResource' -ModuleVersion '0.0.1'
+
+    XOAP_DSCResource 'Example'
+    {
+	    Example [String]= 'Example'
+    }
+}
+XOAP_DSCResource -OutputPath 'C:\XOAP_DSCResource'

DSCResources/XOAP_DSCResource/XOAP_DSCResource.schema.psm1

@@ -1,27 +1,19 @@
-configuration XOAPModuleTemplateDSC
+Configuration 'XOAPModuleTemplateDSC'
 {
-    param
-    (
-        # Target nodes to apply the configuration
-        [string[]]$NodeName = 'localhost'
-    )
+    Import-DSCResource -Module 'XOAPModuleTemplateDSC' -Name 'XOAP_DSCResource' -ModuleVersion '0.0.1'
 
-    Import-Module XOAPModuleTemplateDSC
-    Import-DSCResource -ModuleName XOAPModuleTemplateDSC
+    param
+        (
+            # Target nodes to apply the configuration
+            [string[]]$NodeName = 'localhost'
+        )
 
-    Node $NodeName
+    Node 'XOAPModuleTemplateDSC'
     {
-
-        $moduleRoot = [io.path]::GetDirectoryName((Get-Module XOAPModuleTemplateDSC).Path)
-        #$examples = "$moduleRoot\Examples"
-
-        # Install the IIS role
-        WindowsFeature IIS
+        XOAP_DSCResource 'XOAP_DSCResource'
         {
-            Ensure          = "Present"
-            Name            = "Web-Server"
         }
 
     }
 }
-
+XOAPModuleTemplateDSC -OutputPath 'C:\XOAPModuleTemplateDSC'

Examples/Resources/XOAP_DSCResource.ps1

@@ -12,26 +12,54 @@ Please check out common DSC Community [contributing guidelines](https://dsccommu
 
 ## Change log
 
-A full list of changes in each version can be found in the [change log](CHANGELOG.md).
+A full list of changes in each version can be found in the  [Releases](https://github.com/xoap-io/XOAPModuleTemplateDSC/releases).
 
 ## Documentation
 
 This script is used to easily create new DSC modules and resources.
 
 ## Prerequisites
 
-Please install Plaster first and make sure it's present.
+Be sure that the following DSC modules are installed on your system:
 
-```powershell
-Install-Module Plaster
-Import-Module Plaster
+- ModuleName (x.x.x)
+
+## DSC Resources and syntax
+
+### XOAP_AddServerToCollection
+
+```PowerShell
+XOAP_DSCResource [String] #ResourceName
+    {
+        [DependsOn = [String[]]]
+        [PsDscRunAsCredential = [PSCredential]]
+    }
 ```
 
-## Create new DSC modules
+## Configuration examples for each resource
 
-Modules will be automatically created once you are creating a new DSC resource.
+You can review the [Examples](/Examples/Resources) directory in the **XOAPModuleTemplateDSC** module
+for some general usage scenarios for all the resources that are in the module.
+
+To implement the Module Template DSC module, add the following resources to your DSC configuration and adjust the parameters accordingly:
+
+### Add server to a collection
+
+```PowerShell
+configuration 'XOAP_DSCResource'
+{
+    Import-DscResource -ModuleName 'XOAPModuleTemplateDSC' -Name 'XOAP_DSCResource' -ModuleVersion '0.0.1'
+    
+    XOAP_DSCResource 'Example'
+    {
+          DependsOn = @('[String[]]')
+          PsDscRunAsCredential = [PSCredential]
+    }
+}
+XOAP_DSCResource 
+```
 
-## Create new DSC resources
+## Create new DSC resource
 
 DSC resources can easily be deployed via the invocation of
 
@@ -42,18 +70,5 @@ DSC resources can easily be deployed via the invocation of
 with parameters
 
 ```powershell
-.\New-CompositeResource.ps1 -Module XOAPModuleTemplateDSC -Version 0.0.1 -Resource ScheduledTasks
+.\New-CompositeResource.ps1 -Module 'XOAPModuleTemplateDSC' -Version '0.0.1' -Resource 'DSCResource'
 ```
-
-The parameter list is as followed:
-
-| Parameter | Description                            | Note |
-|-----------|----------------------------------------|------|
-| Module    | Name of the outer module part          | -    |
-| Version   | Target version of the module           | -    |
-| Ressource | The name of the ressource /config part | -    |
-
-### Examples
-
-You can review the [Examples](/Examples/Resources) directory in the **XOAPModuleTemplateDSC** module
-for some general use scenarios for all the resources that are in the module.

Examples/Resources/_dummy

@@ -1,9 +1,9 @@
 #
 # Module manifest for module 'XOAPAModuleTemplate1DSC'
 #
-# Generated by: Sinisa Sokolic
+# Generated by: XOAP.io
 #
-# Generated on: 7/25/2023
+# Generated on: 10/10/2023
 #
 
 @{
@@ -21,16 +21,16 @@ ModuleVersion = '0.0.1'
 GUID = '9300a1eb-8865-4cf3-abf2-bd2f8f7d861d'
 
 # Author of this module
-Author = 'Sinisa Sokolic'
+Author = 'XOAP.io'
 
 # Company or vendor of this module
 CompanyName = 'RIS AG'
 
 # Copyright statement for this module
-Copyright = '(c) 2023 XOAP.io. All rights reserved.'
+Copyright = '(c) XOAP.io. All rights reserved.'
 
 # Description of the functionality provided by this module
-Description = 'Module to configure Azure Virtual Desktop Optimizations on Windows 11. '
+Description = 'Module template for XOAP.io DSC modules.'
 
 # Minimum version of the Windows PowerShell engine required by this module
 PowerShellVersion = '5.1'
@@ -118,7 +118,4 @@ PrivateData = @{
 
 # Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
 # DefaultCommandPrefix = ''
-
 }
-
-