|
5 | 5 | - [Setup](#setup) |
6 | 6 | - [Source Files used in the Module](#source-files-used-in-the-module) |
7 | 7 | - [Module Build Process](#module-build-process) |
8 | | -- [Publishing `SqlQueryClass` Module to GitHub](#publishing-sqlqueryclass-module-to-github) |
| 8 | +- [Publishing `GuiMyPS` Module to GitHub](#publishing-GuiMyPS-module-to-github) |
9 | 9 | - [Code Review and Feedback](#code-review-and-feedback) |
10 | 10 | - [Merge the Pull Request](#merge-the-pull-request) |
11 | 11 | - [Cleanup](#cleanup) |
12 | | -- [Publishing `SqlQueryClass` Module to PowerShell Gallery](#publishing-sqlqueryclass-module-to-powershell-gallery) |
| 12 | +- [Publishing `GuiMyPS` Module to PowerShell Gallery](#publishing-GuiMyPS-module-to-powershell-gallery) |
13 | 13 |
|
14 | 14 | ## Setup |
15 | 15 |
|
16 | 16 | - Uses SQL Express but should work with other SQL Databases with proper connection strings and credentials |
17 | 17 | - Requires VS Code |
18 | | -- For Contributors, Fork the [SqlQueryClass](https://github.com/BrooksV/SqlQueryClass) repository |
| 18 | +- For Contributors, Fork the [GuiMyPS](https://github.com/BrooksV/GuiMyPS) repository |
19 | 19 | - Clone the repository or fork to local pc. I like using c:\git as my local repository folder. Subfolder $ProjectName will be created with the GitHub repository contents |
20 | 20 | - Install [Manjunath Beli's ModuleTools](https://github.com/belibug/ModuleTools) module as the module build process uses ModuleTools |
21 | 21 |
|
|
29 | 29 |
|
30 | 30 | - Public functions that are exported, are separate files in the .\src\public folder. |
31 | 31 | - Private functions that are local to the Module, are separate files in the .\src\private folder. |
32 | | -- - Class Definitions and Enums are not accessible outside of the Module and cannot be accessed directly like Public Functions are. This is a PowerShell limitation. |
33 | | -- - - Classes [SqlQueryDataSet] and [SqlQueryDataSetParms] and enum ResultType used in the Module are defined in file .\src\private\SqlQueryClass.ps1 file. The classes have properties and methods used to maintain a Database connections and result sets making it useful WPF Data binding. |
34 | 32 | - Resources are files and folders in the .\src\resources folder that needs to be included with the Manifest and Module |
35 | 33 |
|
36 | 34 | ## Module Build Process |
|
52 | 50 | Invoke-MTBuild -Verbose |
53 | 51 | ``` |
54 | 52 |
|
55 | | -- - Outputs to the .\dist\SqlQueryClass folder |
56 | | -- - Combines the file contents of the files in Public and Private folder into .\dist\SqlQueryClass\SqlQueryClass.psd1 and exports the Public Functions |
57 | | -- - Generates the .\dist\SqlQueryClass\SqlQueryClass.psd1 Manifest file from the settings in .\project.json |
58 | | -- - Resources (.\src\resources) folder content is copied to .\dist\SqlQueryClass folder |
| 53 | +- - Outputs to the .\dist\GuiMyPS folder |
| 54 | +- - Combines the file contents of the files in Public and Private folder into .\dist\GuiMyPS\GuiMyPS.psd1 and exports the Public Functions |
| 55 | +- - Generates the .\dist\GuiMyPS\GuiMyPS.psd1 Manifest file from the settings in .\project.json |
| 56 | +- - Resources (.\src\resources) folder content is copied to .\dist\GuiMyPS folder |
59 | 57 | - Run the Pester Teats using Invoke-MTTest (Find-Module -Name ModuleTools) |
60 | 58 |
|
61 | 59 | 1. Make corrections, repeat the build process. |
|
64 | 62 | - Upstream your branch. |
65 | 63 | - Create a Pull request. |
66 | 64 |
|
67 | | -## Publishing `SqlQueryClass` Module to GitHub |
| 65 | +## Publishing `GuiMyPS` Module to GitHub |
68 | 66 |
|
69 | 67 | 1. Stage and Commit Your Changes |
70 | 68 |
|
|
85 | 83 | ``` |
86 | 84 |
|
87 | 85 | 1. Create a Pull Request on remote repository |
88 | | - - Go to [SqlQueryClass GitHub repository](https://github.com/BrooksV/SqlQueryClass) |
| 86 | + - Go to [GuiMyPS GitHub repository](https://github.com/BrooksV/GuiMyPS) |
89 | 87 | - Click on "Compare & pull request" for your branch |
90 | 88 | - Provide a meaningful title and description for the PR |
91 | 89 | - Select the base branch (main) to merge into |
@@ -118,7 +116,7 @@ git branch -d features/database-table-access |
118 | 116 |
|
119 | 117 | These steps will ensure your changes are integrated into the main branch and your repository remains organized. |
120 | 118 |
|
121 | | -## Publishing `SqlQueryClass` Module to PowerShell Gallery |
| 119 | +## Publishing `GuiMyPS` Module to PowerShell Gallery |
122 | 120 |
|
123 | 121 | ```powershell |
124 | 122 | $data = Get-MTProjectInfo |
|
0 commit comments