8000 Updated documentation · ModuleBuild/ModuleBuild@6cca933 · GitHub
[go: up one dir, main page]
Skip to content

Commit 6cca933

Browse files
justin-pjustin-p
committed
Updated documentation
1 parent 0b36e44 commit 6cca933

25 files changed

+51
-33
lines changed

‎.vscode/tasks.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
}
5555
},
5656
{
57-
"label": "Test, Build, Install, and Load Module",
57+
"label": "Test, Build, Install and Load Module",
5858
"type": "shell",
5959
"windows": {
6060
"command": "powershell.exe -NoLogo -NoProfile -ExecutionPolicy Bypass -File ${workspaceRoot}\\Build.ps1 -TestBuildAndInstallModule"

‎build/docs/Additional/ChangeLog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ Project Site: [https://github.com/zloeber/ModuleBuild](https://github.com/zloebe
1919
- Updated ModuleBuild/.vscode/settings.json to include default indent size, set indent to space and use the project specific PSScriptAnalyzerSettings.psd1 file.
2020
- Build reports are now saved on the following path `build\reports\$ModuleVersion\`.
2121
- Included functions that are used during the build process are moved to its own repository.
22-
- Included functions that are used during the build process are renamed to avoid conflicts with other modules.
2322
- ModuleBuild now uses PSDepend to manage Build dependencies.
2423
- ModuleBuild now uses PSDepend to manage Plugins.
2524
- Revamped included tests.
2625
- Make.ps1 is no longer dotsourced but included in `MakePlasterManifest.ps1`
2726
- Updated the build scripts to better support CI/CD.
2827
- The included version of Plater is moved to the Plugin folder.
2928
- Added a AppVeyor.yml template to the scaffold.
29+
- All functions are renamed to avoid conflicts with other modules.
3030
- Cleaned up repo. Deleted unused code. Renamed/Moved existing files.
3131
- Updated documentation to reflect above changes.
3232

‎build/docs/ReadTheDocs/Usage/1 - Initialization.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,13 @@ Once this has been kicked off and all answers have been entered, the initializat
1717
## Quick Start
1818
With your new module folder all created there are several steps still left to take in order to make your new project more world class. There are several sections of the following documentation that go over fleshing out the module with public functions, building a release, testing things, out and starting another release. Here are some quick next step tips if you aren't feeling like reading all of that.
1919

20-
1. Add public functions, one per file, to .\src\public (You can use the ModuleBuild function 'Add-MBPublicFunction' for this task)
20+
1. Add public functions, one per file, to '.\src\public'
2121
2. Update your default readme.md file at the root project directory
22-
3. Update the about_ModuleName.help.txt file within .\build\docs\en-US
23-
4. Doing ReadTheDocs integration? Cool, update .\build\docs\ReadTheDocs by creating folders representing sections and putting markdown files within them for the pages within those sections.
24-
5. But remember that the markdown files in .\build\docs\Additional need some love too. These get dropped into your project .\docs directory at every build (overwriting anything there in the process!)
22+
3. Update the about_ModuleName.help.txt file within '.\build\docs\en-US'
23+
4. Doing ReadTheDocs integration? Cool, update '.\build\docs\ReadTheDocs' by creating folders representing sections and putting markdown files within them for the pages within those sections.
24+
5. But remember that the markdown files in '.\build\docs\Additional' need some love too. These get dropped into your project '.\docs' directory at build time (overwriting anything there in the process!)
2525
6. Update any bits within your *.psd1 that are appropriate to your module but don't mess with the exported function names as those get handled automatically when you do the build.
26-
7. If you enabled sensitive terminology scanning then review and update your terms defined in your buildenvironment.json file.
27-
8. Build your project with by running .\Build.ps1, running the build task in VS Code, or running Invoke-Build at your project root.
28-
9. If you have ReadTheDocs integration enabled make sure to re-organize the generated mkdocs.yml to be ordered how you like before pushing your code to github.
26+
7. If you enabled sensitive terminology scanning then review and update your terms defined in your '.\build\YourModule.buildenvironment.json' file or use the 'Set-MBBuildEnvironment.ps1' function.
27+
8. Change your project logo at '.\src\other\powershell-project.png'
28+
9. Build your project with '.\Build.ps1'
29+
10. Enter a PowerShell Gallery (aka Nuget) API key to the '.\build\YourModule.buildenvironment.json' file or use the 'Set-MBBuildEnvironment.ps1' function. Without this you will not be able to upload your module to the PSGallery.

‎build/docs/ReadTheDocs/Usage/4 - Test A Release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ or
1919

2020
or in VS Code
2121

22-
`Ctrl+Shift+B (then select "Test, Build, Install, and Load Module")`
22+
`Ctrl+Shift+B (then select "Test, Build, Install and Load Module")`

‎build/docs/ReadTheDocs/Usage/9 - ModuleBuild Configuration.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,14 @@ What this means is that effectively the base settings defined in modulename.buil
2626

2727
There are a few functions you can use to update or view the configuration.
2828

29+
## Get-MBBuildEnvironment
30+
31+
Use this against a .buildenvironment.json file to pull in and display all the settings within as a psobject. If you don't specify a json file then it will attempt to guess the correct one to use based on the current directory.
32+
33+
## Set-MBBuildEnvironment
34+
35+
Use this against a .buildenvironment.json file to set any of the settings within. Dynamic parameters are used to ensure that this function is effectively forward compatible with any new settings/features/changes to the buildenvironment definitions. If you don't specify a json file then it will attempt to guess the correct one to use based on the current directory.
36+
2937
## Import-MBModulePublicFunction
3038

3139
Use this against an existing module directory to load the module into memory and attempt to extract any defined script functions that have been exported into the public source directory of your ModuleBuild project. No existing file will be overwritten.

‎build/reports/0.3.0/CodeHealthReport-Private.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ <h1>
189189
<div class="col-sm-4 col-md-5 col-lg-4 right-header">
190190
<h5>
191191
Analyzed path :<span class="right-header-data"> src\private</span><br>
192-
Analysis date :<span class="right-header-data"> 2020-04-24 11:53:42Z</span>
192+
Analysis date :<span class="right-header-data"> 2020-04-24 12:08:45Z</span>
193193
</h5>
194194
</div>
195195
</div>

‎build/reports/0.3.0/CodeHealthReport-Public.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ <h1>
189189
<div class="col-sm-4 col-md-5 col-lg-4 right-header">
190190
<h5>
191191
Analyzed path :<span class="right-header-data"> src\public</span><br>
192-
Analysis date :<span class="right-header-data"> 2020-04-24 11:52:09Z</span>
192+
Analysis date :<span class="right-header-data"> 2020-04-24 12:07:23Z</span>
193193
</h5>
194194
</div>
195195
</div>

‎docs/ChangeLog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ Project Site: [https://github.com/zloeber/ModuleBuild](https://github.com/zloebe
1919
- Updated ModuleBuild/.vscode/settings.json to include default indent size, set indent to space and use the project specific PSScriptAnalyzerSettings.psd1 file.
2020
- Build reports are now saved on the following path `build\reports\$ModuleVersion\`.
2121
- Included functions that are used during the build process are moved to its own repository.
22-
- Included functions that are used during the build process are renamed to avoid conflicts with other modules.
2322
- ModuleBuild now uses PSDepend to manage Build dependencies.
2423
- ModuleBuild now uses PSDepend to manage Plugins.
2524
- Revamped included tests.
2625
- Make.ps1 is no longer dotsourced but included in `MakePlasterManifest.ps1`
2726
- Updated the build scripts to better support CI/CD.
2827
- The included version of Plater is moved to the Plugin folder.
2928
- Added a AppVeyor.yml template to the scaffold.
29+
- All functions are renamed to avoid conflicts with other modules.
3030
- Cleaned up repo. Deleted unused code. Renamed/Moved existing files.
3131
- Updated documentation to reflect above changes.
3232

‎docs/Usage/1 - Initialization.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,13 @@ Once this has been kicked off and all answers have been entered, the initializat
1717
## Quick Start
1818
With your new module folder all created there are several steps still left to take in order to make your new project more world class. There are several sections of the following documentation that go over fleshing out the module with public functions, building a release, testing things, out and starting another release. Here are some quick next step tips if you aren't feeling like reading all of that.
1919

20-
1. Add public functions, one per file, to .\src\public (You can use the ModuleBuild function 'Add-MBPublicFunction' for this task)
20+
1. Add public functions, one per file, to '.\src\public'
2121
2. Update your default readme.md file at the root project directory
22-
3. Update the about_ModuleName.help.txt file within .\build\docs\en-US
23-
4. Doing ReadTheDocs integration? Cool, update .\build\docs\ReadTheDocs by creating folders representing sections and putting markdown files within them for the pages within those sections.
24-
5. But remember that the markdown files in .\build\docs\Additional need some love too. These get dropped into your project .\docs directory at every build (overwriting anything there in the process!)
22+
3. Update the about_ModuleName.help.txt file within '.\build\docs\en-US'
23+
4. Doing ReadTheDocs integration? Cool, update '.\build\docs\ReadTheDocs' by creating folders representing sections and putting markdown files within them for the pages within those sections.
24+
5. But remember that the markdown files in '.\build\docs\Additional' need some love too. These get dropped into your project '.\docs' directory at build time (overwriting anything there in the process!)
2525
6. Update any bits within your *.psd1 that are appropriate to your module but don't mess with the exported function names as those get handled automatically when you do the build.
26-
7. If you enabled sensitive terminology scanning then review and update your terms defined in your buildenvironment.json file.
27-
8. Build your project with by running .\Build.ps1, running the build task in VS Code, or running Invoke-Build at your project root.
28-
9. If you have ReadTheDocs integration enabled make sure to re-organize the generated mkdocs.yml to be ordered how you like before pushing your code to github.
26+
7. If you enabled sensitive terminology scanning then review and update your terms defined in your '.\build\YourModule.buildenvironment.json' file or use the 'Set-MBBuildEnvironment.ps1' function.
27+
8. Change your project logo at '.\src\other\powershell-project.png'
28+
9. Build your project with '.\Build.ps1'
29+
10. Enter a PowerShell Gallery (aka Nuget) API key to the '.\build\YourModule.buildenvironment.json' file or use the 'Set-MBBuildEnvironment.ps1' function. Without this you will not be able to upload your module to the PSGallery.

‎docs/Usage/4 - Test A Release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@ or
1919

2020
or in VS Code
2121

22-
`Ctrl+Shift+B (then select "Test, Build, Install, and Load Module")`
22+
`Ctrl+Shift+B (then select "Test, Build, Install and Load Module")`

0 commit comments

Comments
 (0)
0