Skip to content

Commit 8a198e5

Browse files
SQLDBAWithABeardjpomfretFrank-GeislerNowinskiK
authored
Huge PR for Sampler, Pester and some best practices
* remove ready for sampler * adding sampler * Add commit message guidelines for contributors for github copilot This commit introduces a new markdown file that outlines best practices for writing commit messages. It aims to help contributors maintain consistency and clarity in their commit history. * Update README.md to enhance module documentation Expanded the README to provide a clearer overview of the FabricTools PowerShell module, including features, installation instructions, usage examples, and contribution guidelines. This aims to improve user understanding and facilitate contributions during the early development stage. * Enhance CONTRIBUTING.md with detailed guidelines Updated the contributing guidelines to provide clearer instructions for new contributors. Added sections on development workflow, building the module, and testing procedures to facilitate better collaboration and understanding of the project. * Update CONTRIBUTING.md to include GitHub Copilot usage Added instructions for using GitHub Copilot to generate commit messages, enhancing the contribution process. This aims to streamline the workflow for contributors and improve commit message quality. * Add PowerShell functions for managing Fabric workspaces - Implemented Add-FabricWorkspaceRoleAssignment to assign roles to users in a workspace. - Created Get-FabricWorkspace to retrieve all Fabric workspaces. - Developed Get-FabricWorkspace2 for enhanced workspace retrieval with multiple filtering options. - Added Get-FabricWorkspaceDatasetRefreshes to fetch refresh history of datasets in a workspace. - Introduced Get-FabricWorkspaceRoleAssignment to retrieve role assignments for a workspace. - Implemented Get-FabricWorkspaceUsageMetricsData to gather usage metrics for a workspace. - Created Get-FabricWorkspaceUsers to retrieve users associated with a workspace. - Developed New-FabricWorkspace to create a new Fabric workspace. - Added New-FabricWorkspace2 for creating workspaces with capacity and description. - Implemented New-FabricWorkspaceUsageMetricsReport to retrieve usage metrics dataset ID. - Created Register-FabricWorkspaceToCapacity to assign a workspace to a capacity. - Added Remove-FabricWorkspace to delete a workspace. - Implemented Unregister-FabricWorkspaceToCapacity to remove a workspace from a capacity. * Update CONTRIBUTING.md to clarify testing steps Revised the instructions for running Pester tests and building the module. This enhances clarity for contributors on how to execute tests and ensures they understand the importance of the build process before testing. * Add Contributor Covenant Code of Conduct Introduce a comprehensive Code of Conduct to foster an open and welcoming environment for all contributors. This document outlines our pledge, standards, responsibilities, and enforcement policies to ensure a positive community experience. * Add instructions for running specific test tags Updated the CONTRIBUTING.md to include information on running specific test tags such as FunctionalQuality, TestQuality, and HelpQuality. This enhancement aims to provide clearer guidance for contributors on how to execute targeted tests during the development process. * Update CONTRIBUTING.md to clarify installation steps for Microsoft.PowerShell.PSResourceGet module * Add PowerShell functions for managing Fabric recovery points and configurations * Update Assert version in RequiredModules.psd1 Set Assert module version to "0.9.6" for compatibility with the latest features and improvements. * Refactor Register-FabricWorkspaceToCapacity function Move function definition to the top and improve comments for clarity. This enhances readability and maintains consistency in the code structure. Thank you! * Add thank you note to commit message instructions Updated the commit message guidelines to include a friendly thank you note at the end. This change aims to foster a positive contribution culture. Thank you! * Update Documentation for Spark Custom Pool Parameters for Pester Help Tests This commit enhances the documentation for the Update-FabricSparkSettings function by adding descriptions for the optional parameters 'automaticLogEnabled' and 'notebookInteractiveRunEnabled'. This improvement aims to provide clearer guidance for users configuring Spark custom pools. Thank you! * Update Documentation for WorkspaceId Parameter for Pester Help Tests This commit adds a description for the WorkspaceId parameter in the Update-FabricNotebook function. This enhancement improves clarity for users and aids in understanding the function's requirements. Thank you! * Update Parameter Documentation for WorkspaceId for Pester Help Tests This commit adds detailed documentation for the WorkspaceId parameter in the Update-FabricMirroredDatabase function. It clarifies that WorkspaceId is a mandatory field and provides context on its purpose within the function. Thank you! * Update Documentation for WorkspaceId Parameter for KQL Database, KQL Database Definition, KQL Queryset, and Lakehouse for Pester Help Tests This commit enhances the documentation by adding detailed descriptions for the WorkspaceId parameter across multiple scripts. This improvement aims to provide clearer guidance for users regarding the unique identifier of the workspace, ensuring better understanding and usability. Thank you! * Update commit message instructions for clarity Clarify the subject line requirements by adding that it should include "for Pester Help Tests" for better context. Thank you! * Add GitHub Copilot commit message instructions for Pester Help Tests This change introduces a new setting in the VSCode configuration to specify the file for GitHub Copilot's commit message generation instructions. This enhancement aims to improve the clarity and usability of commit messages for Pester Help Tests. Thank you! * Enhance Test-FabricApiResponse Documentation for Pester Help Tests Updated the function documentation to provide clear descriptions of parameters, examples, and notes. This improves usability and understanding for users working with the Fabric API response testing. Thank you! * Update WorkspaceId Parameter Documentation for Pester Help Tests This commit adds detailed documentation for the WorkspaceId parameter across multiple scripts, ensuring clarity on its purpose and usage. This enhancement will aid users in understanding how to effectively utilize the WorkspaceId in their operations. Thank you! * Refactor Set-FabricApiHeaders Function for Pester Help Tests Clean up the Set-FabricApiHeaders function by removing unnecessary blank lines and ensuring consistent formatting. This improves readability and maintainability of the code for Pester Help Tests. Thank you! * Refactor Revoke-FabricExternalDataShares Function for Pester Help Tests Updated the Revoke-FabricExternalDataShares function to improve parameter documentation and code formatting. This enhances clarity and maintainability for future development and testing efforts. Thank you! * Add missing function definition for Resume-FabricCapacity for Pester Help Tests This change ensures that the Resume-FabricCapacity function is properly defined in the script. It enhances the clarity and functionality of the code, making it easier to test and maintain. Thank you! * Remove unnecessary comments and add KQLDatabaseId parameter for Pester Help Tests This update cleans up the Remove-FabricKQLDatabase function by removing the version requirement comment and adding the KQLDatabaseId parameter documentation. This enhances clarity and ensures consistency in the function's usage for Pester Help Tests. Thank you! * Add ItemID parameter to Remove-FabricItem function for Pester Help Tests This change introduces the ItemID parameter to the Remove-FabricItem function, allowing users to specify a particular item to remove regardless of any filters applied. This enhancement improves the function's flexibility and usability in Pester Help Tests. Thank you! * Add blank line for improved readability in Remove-FabricKQLDatabase function for Pester Help Tests This change adds a blank line in the documentation section of the Remove-FabricKQLDatabase function. This improves readability and maintains consistency in the code formatting. Thank you! * Refactor Set-FabricApiHeaders function for Pester Help Tests Updated the synopsis and description for clarity, ensuring that the function's purpose and parameters are clearly defined. This enhances the documentation for better understanding and usability in Pester Help Tests. Thank you! * Refactor Remove-FabricEnvironmentStagingLibrary function for Pester Help Tests This update improves the formatting and readability of the Remove-FabricEnvironmentStagingLibrary function. It ensures consistent spacing and enhances the overall structure of the code, making it easier to maintain and understand. Additionally, the Remove-FabricEventstream function has been updated to include a new parameter for the Eventstream name, providing more flexibility in specifying which Eventstream to delete. Thank you! * Added from #17 * Merge Capacity functions from Tiagos code #17 * Update Private Function file to include a function so that there is no code that will run so that errors are not created and no envrionment is altered during import see #17 * Enhance KQL and Lakehouse Functions - Updated `Update-FabricKQLDatabase` and `Update-FabricKQLDatabaseDefinition` functions to support ShouldProcess for better confirmation handling. - Removed duplicate and obsolete `Get-FabricKQLQueryset copy.ps1` and `Remove-FabricKQLQueryset copy.ps1` scripts. - Refactored `Get-FabricKQLQueryset` to improve clarity and maintainability, ensuring proper error handling and response validation. - Updated `Remove-FabricKQLQueryset` to include ShouldProcess support and improved error logging. - Deleted `Set-FabricKQLQueryset.ps1` as it was no longer needed. - Removed obsolete `New-FabricLakehouse copy.ps1` and refactored `New-FabricLakehouse` to enhance functionality and error handling. - Improved documentation across all modified scripts for clarity and consistency. * Add PowerShell functions for managing Fabric tenant settings and workspaces - Implement Get-FabricTenantSetting to retrieve tenant settings from the Fabric environment. - Add Get-FabricWorkspaceTenantSettingOverrides to fetch tenant setting overrides for all workspaces. - Create Revoke-FabricCapacityTenantSettingOverrides to remove tenant setting overrides from specific capacities. - Develop Update-FabricCapacityTenantSettingOverrides for updating tenant setting overrides for specified capacities. - Introduce Update-FabricTenantSetting for updating tenant settings with various parameters. - Add Add-FabricWorkspaceIdentity to provision identities for Fabric workspaces. - Implement Assign-FabricWorkspaceCapacity to assign workspaces to specific capacities. - Create Remove-FabricWorkspaceIdentity to deprovision identities from workspaces. - Develop Remove-FabricWorkspaceRoleAssignment to delete role assignments from workspaces. - Introduce Unassign-FabricWorkspaceCapacity to unassign workspaces from their capacities. - Implement Update-FabricWorkspace for updating workspace properties. - Create Update-FabricWorkspaceRoleAssignment to update role assignments for principals in workspaces. * Refactor Base64 conversion functions for clarity #16 #20 Updated the Convert-FromBase64 and Convert-ToBase64 functions to improve code readability and maintainability. Removed unnecessary author notes and ensured consistent formatting. This will help in easier understanding and usage of the functions for Pester Help Tests. Thank you! * Refactor Get-FabricCopyJob function for clarity #16 #20 Improved the structure and readability of the Get-FabricCopyJob function by removing unnecessary lines and ensuring consistent formatting. This change enhances maintainability and prepares the code for future updates. Thank you! * Remove commented-out paths in build.yaml for clarity This change cleans up the build.yaml file by removing unnecessary commented-out paths. This helps improve readability and maintainability of the configuration file for Pester Help Tests. Thank you! * Add detailed documentation for PowerShell functions Incomplete Help #16 This commit enhances the documentation for various PowerShell functions in the Set-WellKnown.ps1 script. Each function now includes a synopsis, description, parameters, and examples to improve clarity and usability. This will help users understand the purpose and usage of the functions better, especially for Pester Help Tests. Thank you! * Rename function for consistency and clarity Updated the function name from Get-AllFabricDatasetRefreshes to Get-FabricDatasetRefreshes for better alignment with naming conventions. This change enhances readability and maintains consistency across the codebase. Thank you! * Remove Get-AllFabricCapacities function for clarity This commit removes the Get-AllFabricCapacities function from the codebase. The function was deemed unnecessary and its removal helps to streamline the code and improve maintainability. Thank you! * Add Get-FabricCapacities function for Pester Help Tests This commit introduces the Get-FabricCapacities function, which retrieves all resources of type "Microsoft.Fabric/capacities" from specified subscriptions or all subscriptions if no ID is provided. This enhancement improves the functionality and usability of the script for users needing to access capacity resources in Azure. Thank you! * Refactor Help Tests to Filter by Exported Commands for Pester Help Tests Updated the Help tests to ensure they only iterate over functions that are exported by the module. This change enhances the accuracy of the tests and ensures compliance with the module's exported command structure. Thank you! * Refactor Functions for Consistency and Clarity for Help #16 #17 Updated multiple functions to ensure consistent formatting and clarity in their definitions. This change enhances readability and maintainability of the codebase for Pester Help Tests. Thank you! * Refactor Functions for Consistency and Clarity for Pester Help Tests #16 #24 This commit refactors multiple functions to improve consistency and clarity across the codebase. Changes include renaming functions, updating documentation, and ensuring uniform formatting. These enhancements aim to make the code more maintainable and easier to understand for future development. Thank you! * Refactor Functions for Clarity and Consistency for Pester Help Tests Incomplete Help #16 #24 This commit refactors the Get-FabricWorkspaceDatasetRefreshes, Get-FabricWorkspaceUsageMetricsData, and Get-FabricWorkspaceUsers functions to improve clarity and consistency. The function definitions have been streamlined, and aliases have been maintained for flexibility. Thank you! * Enhance Documentation for Import-FabricItem Function for Pester Help Tests Incomplete Help #16 Updated the function documentation to provide a clearer description of the Import-FabricItem function, including its capabilities and how it handles the import of datasets and reports. This change aims to improve clarity for users and maintain consistency across the codebase. Thank you! * rename duplicate function This update refactors the Invoke-FabricAPIRequest function to improve clarity and consistency in the code. The changes include enhancing documentation, organizing parameters, and ensuring better readability. These improvements will facilitate easier testing and maintenance for Pester Help Tests. Thank you! * Enhance PowerShell scripts for Microsoft Fabric Incomplete Help #16 #24 - Added parameters for subscription ID and resource group name in Get-FabricCapacitySkus.ps1. - Renamed CopyJobName parameter to CopyJob in Get-FabricCopyJob.ps1 for clarity. - Updated Get-FabricDataPipeline.ps1 to include parameters for DataPipelineId and DataPipelineName. - Enhanced Get-FabricDatamart.ps1 with optional parameters for datamartId and datamartName. - Added EnvironmentId parameter to Get-FabricEnvironment.ps1 for specific environment retrieval. - Introduced Workspace parameter and itemID in Get-FabricItem.ps1 for improved item retrieval. - Added WorkspaceId parameter in Update-FabricKQLDashboard.ps1 for specifying the workspace. - Enhanced Get-FabricKQLDatabase.ps1 with optional KQLDatabaseId and KQLDatabaseName parameters. - Expanded New-FabricKQLDatabase.ps1 with additional parameters for KQL invitation token and source cluster URI. - Updated Get-FabricKQLQueryset.ps1 to include KQLQuerysetId for specific query set retrieval. - Enhanced Get-FabricLakehouse.ps1 with LakehouseId parameter for specific lakehouse retrieval. - Added MirroredDatabaseId parameter in Get-FabricMirroredDatabase.ps1 for specific mirrored database retrieval. - Introduced MirroredWarehouseId parameter in Get-FabricMirroredWarehouse.ps1 for specific mirrored warehouse retrieval. - Enhanced Get-FabricNotebook.ps1 with NotebookId parameter for specific notebook retrieval. - Added location parameter in Get-FabricLongRunningOperation.ps1 for operation status checking. - Expanded New-FabricWorkspace.ps1 with optional parameters for WorkspaceDescription and CapacityId. * Refactor Script Analyzer Test for Pester Help Tests Updated the Script Analyzer test to filter test cases based on exported commands. This change ensures that only relevant functions are analyzed, improving the accuracy of the tests. Thank you! * Refactor Add-FabricWorkspaceIdentity for Pester Help Tests Clean up whitespace and improve readability in the Add-FabricWorkspaceIdentity function. This enhances the code quality and maintains consistency for Pester Help Tests. Thank you! * used the dbatools formatter * extra space in help * Fix parameter naming in Get-FabricCopyJob function and update examples * Update CONTRIBUTING.md with proper code formatting Signed-off-by: Rob Sewell <[email protected]> * test pushing conflicted files * lets run some tests on PR * sample branches to test with * Updated the test command in the workflow to ensure proper execution by removing the unnecessary module import. This change helps avoid issues with loading dependencies during testing. * Remove temporary test branch from workflow for Pester Help Tests This change simplifies the workflow configuration by removing the unnecessary 'testBranch' entry. This helps maintain clarity and focus on the relevant branches for testing. Thank you! * fix for #25 add config variables to private function so executed on build * Fix formatting in Get-FabricDatamart example and add error logging message * Added an important box for important content. * Update CONTRIBUTING.md for clarity and structure Refine the development workflow instructions for better readability and understanding. Adjusted the numbering and formatting for consistency. This will help contributors follow the guidelines more easily for Pester Help Tests. * Update CONTRIBUTING.md for clarity and structure Refine the development and testing instructions for better understanding. Enhance the formatting of sections and emphasize important guidelines for contributors. Thank you! * Update Code of Conduct for clarity and inclusivity This update enhances the Code of Conduct to ensure a welcoming, respectful, and inclusive environment for all contributors. It outlines expected behaviors and the consequences of unacceptable actions. * Add standard tests for each function (#35) * tests for all * Add OutputType attributes for improved type safety This update introduces OutputType attributes to several functions, enhancing type safety and providing better integration with tools that rely on type information. This change will help users understand the expected output of these functions more clearly, which is beneficial for Pester Help Tests. Thank you! * Add SuppressMessageAttribute for Pester Help Tests This change adds a SuppressMessageAttribute to the Set-FabricAuthToken function. This adjustment is necessary to allow the current unit tests to pass without warnings related to the use of ConvertToSecureString with plain text. Thank you! * So that the naming of functions matches approved PowerShell Verbs fixes #14 - Added Remove-FabricDomainWorkspaceAssignment to unassign workspaces from a Fabric domain. - Introduced Remove-FabricDomainWorkspaceRoleAssignment for bulk unassigning roles from principals in a Fabric domain. - Created Import-FabricEnvironmentStagingLibrary to upload libraries to the staging environment in a Fabric workspace. - Developed Write-FabricLakehouseTableData to load data into Lakehouse tables from files or folders. - Implemented Add-FabricWorkspaceCapacityAssignment to assign a workspace to a specified capacity. - Added Remove-FabricWorkspaceCapacityAssignment to unassign a workspace from its capacity. - Created unit tests for all new functions to ensure parameter validation and functionality. * change file and test name * remove file to match develop - missed commit * Refactor PowerShell functions to support ShouldProcess for safer execution fixes #12 - Updated multiple functions across various scripts to include [CmdletBinding(SupportsShouldProcess)] for better user confirmation before executing potentially destructive actions. - Enhanced error handling by restructuring try-catch blocks for improved readability and consistency. - Ensured that API requests are wrapped in ShouldProcess checks to prevent unintended changes. - Cleaned up code formatting and improved validation checks for input parameters. * Add WhatIf and Confirm parameters to various FabricTools update tests for Missing Pester Tests #7 - Updated expected parameters in the following test files to include "WhatIf" and "Confirm": - Update-FabricEventhouseDefinition.Tests.ps1 - Update-FabricEventstream.Tests.ps1 - Update-FabricEventstreamDefinition.Tests.ps1 - Update-FabricKQLDashboard.Tests.ps1 - Update-FabricKQLDashboardDefinition.Tests.ps1 - Update-FabricKQLDatabase.Tests.ps1 - Update-FabricKQLDatabaseDefinition.Tests.ps1 - Update-FabricKQLQueryset.Tests.ps1 - Update-FabricKQLQuerysetDefinition.Tests.ps1 - Update-FabricLakehouse.Tests.ps1 - Update-FabricMLExperiment.Tests.ps1 - Update-FabricMLModel.Tests.ps1 - Update-FabricMirroredDatabase.Tests.ps1 - Update-FabricMirroredDatabaseDefinition.Tests.ps1 - Update-FabricNotebook.Tests.ps1 - Update-FabricNotebookDefinition.Tests.ps1 - Update-FabricPaginatedReport.Tests.ps1 - Update-FabricReflex.Tests.ps1 - Update-FabricReflexDefinition.Tests.ps1 - Update-FabricReport.Tests.ps1 - Update-FabricReportDefinition.Tests.ps1 - Update-FabricSemanticModel.Tests.ps1 - Update-FabricSemanticModelDefinition.Tests.ps1 - Update-FabricSparkCustomPool.Tests.ps1 - Update-FabricSparkJobDefinition.Tests.ps1 - Update-FabricSparkJobDefinitionDefinition.Tests.ps1 - Update-FabricSparkSettings.Tests.ps1 - Update-FabricWarehouse.Tests.ps1 - Update-FabricWorkspace.Tests.ps1 - Update-FabricWorkspaceRoleAssignment.Tests.ps1 - Write-FabricLakehouseTableData.Tests.ps1 * Add Pester Help Tests for Get-FabricAPIclusterURI and Get-FabricCapacityTenantOverrides This commit introduces unit tests for the Get-FabricAPIclusterURI and Get-FabricCapacityTenantOverrides functions to ensure proper parameter validation and functionality. These tests will help maintain code quality and reliability as the project evolves. Thank you! * Update CodeCoverageThreshold for Pester Help Tests Adjust the CodeCoverageThreshold from 85 to 0.35 to better align with current testing requirements for Pester Help Tests. This change aims to improve the accuracy of code coverage metrics. Thank you! --------- Co-authored-by: Rob Sewell <[email protected]> * update issue template for new function * The requirement for PS7 has been abolished #4 * Added unit test & fixed validation for WorkspaceName in Get-FabricWorkspace cmdlet #28 * Apply suggestions from code review the `-` needs to be escaped within the regular expression (good test, that caught this issue!) Signed-off-by: Jess Pomfret <[email protected]> * Validation correction fixes #28 fixes #41 * Update CmdletBinding to include ConfirmImpact - closes ConfirmImpact of destructive functions should be high #46 This change enhances the safety of the following functions by setting the ConfirmImpact to 'High': - Remove-FabricDomainWorkspaceRoleAssignment - Remove-FabricEnvironment - Remove-FabricEventhouse - Remove-FabricEventstream - Revoke-FabricExternalDataShares - Remove-FabricItem - Remove-FabricMLModel - Remove-FabricReflex - Remove-FabricSQLDatabase - Remove-FabricSparkJobDefinition - Remove-FabricSparkCustomPool - Revoke-FabricCapacityTenantSettingOverrides - Remove-FabricWarehouse This ensures that users are prompted for confirmation before executing potentially destructive actions. Thank you! * Fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 (#45) * fix for #39 * contenttype not used so post commands were failign * correct comment wording * update api call to fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * formatting & spelling * whitespace changes * lets have a copyJob when we ask for one not a warehouse * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * change confirmImpact to high so confirm works cc. @SQLDBAWithABeard * fix for New-FabricDataPipeline - issue with call to Invoke-FabricAPIRequest #39 * fix for #39 * Removed leading slash from $apiEndpointURI #39 * Removed leading slash #39 --------- * Add ShouldProcess support for revoke functions Enhance the Revoke-FabricExternalDataShares and Revoke-FabricCapacityTenantSettingOverrides functions to include ShouldProcess support, allowing for confirmation prompts before executing the revoke actions. This improves safety and user control over destructive operations. Also, update the corresponding test files to include new parameters for Confirm and WhatIf, ensuring comprehensive testing for these changes. Thank you! --------- Signed-off-by: Rob Sewell <[email protected]> Signed-off-by: Jess Pomfret <[email protected]> Co-authored-by: jpomfret <[email protected]> Co-authored-by: Frank Geisler <[email protected]> Co-authored-by: Kamil Nowinski <[email protected]>
1 parent 2fe4ced commit 8a198e5

File tree

556 files changed

+19874
-30448
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

556 files changed

+19874
-30448
lines changed

.gitattributes

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Needed for publishing of examples, build worker defaults to core.autocrlf=input.
2+
* text eol=autocrlf
3+
4+
*.mof text eol=crlf
5+
*.sh text eol=lf
6+
*.svg eol=lf
7+
8+
# Ensure any exe files are treated as binary
9+
*.exe binary
10+
*.jpg binary
11+
*.xl* binary
12+
*.pfx binary
13+
*.png binary
14+
*.dll binary
15+
*.so binary

.github/ISSUE_TEMPLATE/General.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
name: General question or documentation update
3+
about: If you have a general question or documentation update suggestion around the resource module.
4+
---
5+
<!--
6+
Your feedback and support is greatly appreciated, thanks for contributing!
7+
-->
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
name: Problem with the module
2+
description: If you have a problem using this module, want to report a bug, or suggest an enhancement to this module.
3+
labels: []
4+
assignees: []
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
TITLE: Please be descriptive not sensationalist.
10+
11+
Your feedback and support is greatly appreciated, thanks for contributing!
12+
13+
Please provide information regarding your issue under each section below.
14+
**Write N/A in sections that do not apply, or if the information is not available.**
15+
- type: textarea
16+
id: description
17+
attributes:
18+
label: Problem description
19+
description: Details of the scenario you tried and the problem that is occurring, or the enhancement you are suggesting.
20+
validations:
21+
required: true
22+
- type: textarea
23+
id: logs
24+
attributes:
25+
label: Verbose logs
26+
description: |
27+
Verbose logs showing the problem. **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as plain text._
28+
placeholder: |
29+
Paste verbose logs here
30+
render: text
31+
validations:
32+
required: true
33+
- type: textarea
34+
id: reproducible
35+
attributes:
36+
label: How to reproduce
37+
description: Provide the steps to reproduce the problem.
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: expectedBehavior
42+
attributes:
43+
label: Expected behavior
44+
description: Describe what you expected to happen.
45+
validations:
46+
required: true
47+
- type: textarea
48+
id: currentBehavior
49+
attributes:
50+
label: Current behavior
51+
description: Describe what actually happens.
52+
validations:
53+
required: true
54+
- type: textarea
55+
id: suggestedSolution
56+
attributes:
57+
label: Suggested solution
58+
description: Do you have any suggestions how to solve the issue?
59+
validations:
60+
required: true
61+
- type: textarea
62+
id: targetNodeOS
63+
attributes:
64+
label: Operating system you are running FabricTools on
65+
description: |
66+
Please provide as much as possible about the node running FabricTools. _Will be automatically formatted as plain text._
67+
68+
To help with this information:
69+
- On a Linux distribution, please provide the distribution name, version, and release. The following command can help get this information: `cat /etc/*-release && cat /proc/version`
70+
- On macOS, please provide the product version and build version. The following command can help get this information: `sw_vers`
71+
- On a Windows OS please provide edition, version, build, and language. The following command can help get this information: `Get-ComputerInfo -Property @('OsName','OsOperatingSystemSKU','OSArchitecture','WindowsVersion','WindowsBuildLabEx','OsLanguage','OsMuiLanguages')`
72+
placeholder: |
73+
Add operating system information here
74+
render: text
75+
validations:
76+
required: true
77+
- type: textarea
78+
id: targetNodePS
79+
attributes:
80+
label: PowerShell version and build the target node is running
81+
description: |
82+
Please provide the version and build of PowerShell the target node is running. _Will be automatically formatted as plain text._
83+
84+
To help with this information, please run this command: `$PSVersionTable`
85+
placeholder: |
86+
Add PowerShell information here
87+
render: text
88+
validations:
89+
required: true
90+
- type: textarea
91+
id: moduleVersion
92+
attributes:
93+
label: Module version used
94+
description: |
95+
Please provide the version of the FabricTools module that was used. _Will be automatically formatted as plain text._
96+
97+
To help with this information, please run this command: `Get-Module -Name 'FabricTools' -ListAvailable | ft Name,Version,Path`
98+
placeholder: |
99+
Add module information here
100+
render: text
101+
validations:
102+
required: true
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
name: Problem with a function
2+
description: If you have a problem, bug, or enhancement with a function in this module.
3+
labels: []
4+
assignees: []
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please prefix the issue title (above) with the function name, e.g. 'FunctionName: Short description of my issue'!
10+
11+
Your feedback and support is greatly appreciated, thanks for contributing!
12+
- type: textarea
13+
id: description
14+
attributes:
15+
label: Problem description
16+
description: Details of the scenario you tried and the problem that is occurring.
17+
validations:
18+
required: true
19+
- type: textarea
20+
id: logs
21+
attributes:
22+
label: Verbose logs
23+
description: |
24+
Verbose logs showing the problem. **NOTE! Sensitive information should be obfuscated.** _Will be automatically formatted as plain text._
25+
placeholder: |
26+
Paste verbose logs here
27+
render: text
28+
validations:
29+
required: true
30+
- type: textarea
31+
id: version
32+
attributes:
33+
label: Module Version
34+
description: |
35+
The version of the FabricTools module you are using. _Will be automatically formatted as plain text._
36+
To help with this information, please run this command: `Get-Module -Name 'FabricTools' | ft Name,Version,Path`
37+
placeholder: |
38+
Paste output here
39+
validations:
40+
required: true
41+
- type: textarea
42+
id: suggestedSolution
43+
attributes:
44+
label: Suggested solution
45+
description: Do you have any suggestions how to solve the issue?
46+
validations:
47+
required: true
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: New function proposal
2+
description: If you have a new function proposal that you think should be added to this module.
3+
title: "NewFunctionName: New resource proposal"
4+
labels: []
5+
assignees: []
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Please replace `NewFunctionName` in the issue title (above) with your proposed function name.
11+
12+
Thank you for contributing and making FabricTools better!
13+
- type: textarea
14+
id: description
15+
attributes:
16+
label: Function proposal
17+
description: Provide information how this function will/should work and how it will help users.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: proposedProperties
22+
attributes:
23+
label: Proposed properties
24+
description: |
25+
List all the proposed properties and parameters that the function should have.
26+
value: |
27+
Parameter | Description | Data type | Default value | Allowed values
28+
--- | --- | --- | --- | ---
29+
ParameterName | Detailed description | String | None | Any
30+
31+
Property | Description
32+
--- | ---
33+
PropertyName | Detailed description
34+
validations:
35+
required: true
36+
- type: textarea
37+
id: considerations
38+
attributes:
39+
label: Special considerations or limitations
40+
description: |
41+
Provide any considerations or limitations you can think of that a contributor should take in account when coding the proposed function, and or what limitations a user will encounter or should consider when using the proposed function.
42+
validations:
43+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: "FabricTools Community"
4+
url: https://github.com/dataplat/FabricTools/discussions
5+
about: "To talk to the community and maintainers of FabricTools, please head to GitHub discussions."

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Pull Request
2+
3+
<!--
4+
Thanks for submitting a Pull Request (PR) to this project.
5+
Your contribution to this project is greatly appreciated!
6+
7+
TITLE: Please be descriptive not sensationalist.
8+
Prepend the title with the [DscResourceName] if your PR is specific to a DSC resource.
9+
Also prepend with [BREAKING CHANGE] if relevant.
10+
i.e. [BREAKING CHANGE][xFile] Add security descriptor property
11+
12+
You may remove this comment block, and the other comment blocks, but please
13+
keep the headers and the task list.
14+
Try to keep your PRs atomic: changes grouped in smallest batch affecting a single logical unit.
15+
-->
16+
17+
## Pull Request (PR) description
18+
19+
<!--
20+
Replace this comment block with a description of your PR to provide context.
21+
Please be describe the intent and link issue where the problem has been discussed.
22+
try to link the issue that it fixes by providing the verb and ref: [fix|close #18]
23+
24+
After the description, please concisely list the changes as per keepachangelog.com
25+
This **should** duplicate what you've updated in the changelog file.
26+
27+
### Added
28+
- for new features [closes #15]
29+
### Changed
30+
- for changes in existing functionality.
31+
### Deprecated
32+
- for soon-to-be removed features.
33+
### Security
34+
- in case of vulnerabilities.
35+
### Fixed
36+
- for any bug fixes. [fix #52]
37+
### Removed
38+
- for now removed features.
39+
-->
40+
41+
## Task list
42+
43+
<!--
44+
To aid community reviewers in reviewing and merging your PR, please take
45+
the time to run through the below checklist and make sure your PR has
46+
everything updated as required.
47+
48+
Change to [x] for each task in the task list that applies to your PR.
49+
For those task that don't apply to you PR, leave those as is.
50+
-->
51+
52+
- [ ] The PR represents a single logical change. i.e. Cosmetic updates should go in different PRs.
53+
- [ ] Added an entry under the Unreleased section of in the CHANGELOG.md as per [format](https://keepachangelog.com/en/1.0.0/).
54+
- [ ] Local clean build passes without issue or fail tests (`build.ps1 -ResolveDependency`).
55+
- [ ] Resource documentation added/updated in README.md.
56+
- [ ] Resource parameter descriptions added/updated in README.md, schema.mof
57+
and comment-based help.
58+
- [ ] Comment-based help added/updated.
59+
- [ ] Localization strings added/updated in all localization files as appropriate.
60+
- [ ] Examples appropriately added/updated.
61+
- [ ] Unit tests added/updated. See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
62+
- [ ] Integration tests added/updated (where possible). See [DSC Resource Testing Guidelines](https://github.com/PowerShell/DscResources/blob/master/TestsGuidelines.md).
63+
- [ ] New/changed code adheres to [DSC Resource Style Guidelines](https://github.com/PowerShell/DscResources/blob/master/StyleGuidelines.md) and [Best Practices](https://github.com/PowerShell/DscResources/blob/master/BestPractices.md).
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Limit the subject line to 50 characters
2+
Capitalize the subject/description line
3+
Do not end the subject line with a period
4+
Separate the subject from the body with a blank line
5+
Use the imperative mood in the subject line
6+
The subject line should be a single sentence with an action word and target with some reasoning add "for Pester Help Tests"
7+
Use the body to explain what and why in a friendly kind manner
8+
Say thank you at the end of the message

0 commit comments

Comments
 (0)