Merge branch 'main' into add-whatif

.github/ISSUE_TEMPLATE/Bug_Report.yml

@@ -0,0 +1,117 @@
+name: Bug report 🐛
+description: Report errors or unexpected behavior 🤔
+labels:
+  - Issue-Bug
+  - Need-Review
+body:
+- 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 version
+      required: true
+    - label: Search the existing issues.
+      required: true
+- type: textarea
+  attributes:
+    label: Summary
+    description: >-
+      Write a short description of the issue at a high-level.
+    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: 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: |-
+      1. Create the following configuration document:
+
+         ```yaml
+         # repro.dsc.config.yaml
+         $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/config/document.json
+         resources:
+         - name: repro
+           type: Test/Echo
+           properties:
+             output: expected value
+         ```
+
+      1. Call the `get` operation on the repro document:
+
+         ```sh
+         dsc config get --path ./repro.dsc.config.yaml
+         ```
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Expected behavior
+    render: console
+    placeholder: |
+      dsc config get --path ./repro.dsc.config.yaml
+      
+      results:
+      - name: repro
+        type: Test/Echo
+        result:
+          actualState:
+            output: expected value
+      messages: []
+      hadErrors: false
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Actual behavior
+    render: console
+    placeholder: |
+      # Enable debug tracing, which shouldn't contain any private data
+      dsc -l debug config get --path ./repro.dsc.config.yaml
+      
+      results:
+      - name: repro
+        type: Test/Echo
+        result:
+          actualState:
+            output: other value
+      messages: []
+      hadErrors: false
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: Error details
+    description: Paste verbatim output from DSC if it returns an error
+    render: console
+- 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 you're using. Run the `dsc --version` command to get
+      the current version.
+    placeholder: 3.0.0-alpha.5
+
+- 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.

.github/ISSUE_TEMPLATE/Feature_Request.yml

@@ -0,0 +1,27 @@
+name: Feature Request / Idea 🚀
+description: >-
+  Suggest a new feature or improvement (this doesn't 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 experience with expected result.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,6 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Ask a question
+    url: https://github.com/PowerShell/DSC/discussions/new?category=q-a
+    about: >-
+      If you have a question about DSC, the docs, or this project, ask it here.

.github/workflows/rust.yml

@@ -9,6 +9,7 @@ on:
       - "docs/**"
       - "*.md"
       - ".vscode/*.json"
+      - ".github/ISSUE_TEMPLATE/**"
 
 env:
   CARGO_TERM_COLOR: always

.vscode/docs.code-snippets

@@ -0,0 +1,186 @@
+{
+	// Place your DSCv3 workspace snippets here. Each snippet is defined under a snippet name and has a scope, prefix, body and 
+	// description. Add comma separated ids of the languages where the snippet is applicable in the scope field. If scope 
+	// is left empty or omitted, the snippet gets applied to all languages. The prefix is what is 
+	// used to trigger the snippet and the body will be expanded and inserted. Possible variables are: 
+	// $1, $2 for tab stops, $0 for the final cursor position, and ${1:label}, ${2:another} for placeholders. 
+	// Placeholders with the same ids are connected.
+	"Configuration function template": {
+		"scope": "markdown",
+		"prefix": "docs-config-func-template",
+		"description": "Template for a DSC configuration function reference document",
+		"isFileTemplate": true,
+		"body": [
+			"---",
+			"description: Reference for the '${1:name}' DSC configuration document function",
+			"ms.date:     $CURRENT_MONTH/$CURRENT_DATE/$CURRENT_YEAR",
+			"ms.topic:    reference",
+			"title:       ${1:name}",
+			"---",
+			"",
+			"# ${1:name}",
+			"",
+			"## Synopsis",
+			"",
+			"${2:One sentence description}",
+			"",
+			"## Syntax",
+			"",
+			"```Syntax",
+			"${1:name}(${3:input syntax})",
+			"```",
+			"",
+			"## Description",
+			"",
+			"The `${1:name}` function ${4:full description}.",
+			"",
+			"## Examples",
+			"",
+			"### Example 1 - ${5:example title}",
+			"",
+			"${6:example synopsis}",
+			"",
+			"```yaml",
+			"# ${1:name}.example.1.dsc.config.yaml",
+			"\\$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/config/document.json",
+			"resources:",
+			"- name: ${7:descriptive resource name}",
+			"  type: Test/Echo",
+			"  properties:",
+			"    output: \"[${1:name}(${8:example input})]\"",
+			"```",
+			"",
+			"```bash",
+			"dsc config get --document ${1:name}.example.1.dsc.config.yaml",
+			"```",
+			"",
+			"```yaml",
+			"results:",
+			"- name: ${7:descriptive resource name}",
+			"  type: Test/Echo",
+			"  result:",
+			"    actualState:",
+			"      output: ${9:example output}",
+			"messages: []",
+			"hadErrors: false",
+			"```",
+			"",
+			"## Parameters",
+			"",
+			"### ${10:parameter name}",
+			"",
+			"${11:parameter description}",
+			"",
+			"```yaml",
+			"Type:         ${12:parameter type}",
+			"Required:     ${13:whether parameter is mandatory}",
+			"MinimumCount: ${14:1}",
+			"MaximumCount: ${15:1}",
+			"```",
+			"",
+			"## Output",
+			"",
+			"${16:output description}",
+			"",
+			"```yaml",
+			"Type: ${17:output type}",
+			"```",
+			"",
+			"<!-- Link reference definitions -->",
+			""
+		  ]
+	},
+	"Configuration function example": {
+		"scope": "markdown",
+		"prefix": "docs-config-func-example",
+		"description": "Add an example to a DSC configuration function reference document",
+		"body": [
+			"### Example ${1:exampleIndex} - ${2:example title}",
+			"",
+			"${3:example synopsis}",
+			"",
+			"```yaml",
+			"# $TM_FILENAME_BASE.example.$1.dsc.config.yaml",
+			"\\$schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/10/config/document.json",
+			"resources:",
+			"- name: ${4:descriptive resource name}",
+			"  type: Test/Echo",
+			"  properties:",
+			"    output: \"[$TM_FILENAME_BASE(${5:example input})]\"",
+			"```",
+			"",
+			"```bash",
+			"dsc config get --document ${TM_FILENAME_BASE}.example.$1.dsc.config.yaml",
+			"```",
+			"",
+			"```yaml",
+			"results:",
+			"- name: $4",
+			"  type: Test/Echo",
+			"  result:",
+			"    actualState:",
+			"      output: ${6:example output}",
+			"messages: []",
+			"hadErrors: false",
+			"```"
+		]
+	},
+	"Changelog Entry": {
+		"scope": "markdown",
+		"prefix": "docs-changelog-entry-single-issue-pr",
+		"description": "Template for a DSC changelog entry",
+		"body": [
+			"- ${1:Change description}",
+			"",
+			"  <details><summary>Related work items</summary>",
+			"",
+			"  - Issues: [#${2:related issue id}][#${2:related issue id}]",
+			"  - PRs: [#${3:related pull request id}][#${3:related pull request id}]",
+			"",
+			"  <details>",
+			""
+		]
+	}
+	"Changelog Entry Multi Item": {
+		"scope": "markdown",
+		"prefix": "docs-changelog-entry-multi-issue-pr",
+		"description": "Template for a DSC changelog entry",
+		"body": [
+			"- ${1:Change description}",
+			"",
+			"  <details><summary>Related work items</summary>",
+			"",
+			"  - Issues:",
+			"    - [#${2:related issue id}][#${2:related issue id}]",
+			"  - PRs:",
+			"    - [#${3:related pull request id}][#${3:related pull request id}]",
+			"",
+			"  <details>",
+			""
+		]
+	}
+	"Changelog release heading": {
+		"scope": "markdown",
+		"prefix": "docs-changelog-release-heading",
+		"description": "Template for a DSC changelog release heading",
+		"body": [
+			"## [${1:v3.0.0-${2:alpha.5}}][release-${1:v3.0.0-${2:alpha.5}}] - ${3:${CURRENT_YEAR}-${CURRENT_MONTH}-${CURRENT_DATE}}",
+			"",
+			"This section includes a summary of changes for the `${2:alpha.5}` release. For the full list of changes",
+			"in this release, see the [diff on GitHub][compare-${1:v3.0.0-${2:alpha.5}}].",
+			"",
+			"<!-- Release links -->",
+			"[release-${1:v3.0.0-${2:alpha.5}}]: https://github.com/PowerShell/DSC/releases/tag/${1:v3.0.0-${2:alpha.5}} \"Link to the DSC ${1:v3.0.0-${2:alpha.5}} release on GitHub\"",
+			"[compare-${1:v3.0.0-${2:alpha.5}}]: https://github.com/PowerShell/DSC/compare/v3.0.0-alpha.4...${1:v3.0.0-${2:alpha.5}}"
+		]
+
+	}
+	"Github Work Item Link": {
+		"scope": "markdown",
+		"prefix": "docs-gh-link",
+		"description": "Template for a DSC Github work item link",
+		"body": [
+			"[#${1:work item id}]: https://github.com/PowerShell/DSC/issues/${1:work item id}"
+		]
+	}
+}

.vscode/settings.json

@@ -13,12 +13,12 @@
     "json.schemas": [
         {
             "fileMatch": ["**/*.dsc.resource.json"],
-            "url": "/schemas/2023/10/bundled/resource/manifest.vscode.json"
+            "url": "/schemas/2024/04/bundled/resource/manifest.vscode.json"
         }
     ],
     "yaml.schemas": {
-        "schemas/2023/10/bundled/config/document.vscode.json": "**.dsc.{yaml,yml,config.yaml,config.yml}",
-        "schemas/2023/10/bundled/resource/manifest.vscode.json": "**.dsc.resource.{yaml,yml}"
+        "schemas/2024/04/bundled/config/document.vscode.json": "**.dsc.{yaml,yml,config.yaml,config.yml}",
+        "schemas/2024/04/bundled/resource/manifest.vscode.json": "**.dsc.resource.{yaml,yml}"
     },
     "sarif-viewer.connectToGithubCodeScanning": "off"
 }