|
2 | 2 |
|
3 | 3 | Insert a useful description for the þnameþ project here.
|
4 | 4 |
|
5 |
| -Remember, it's the first thing a visitor will see. |
| 5 | +Remember, it's the first thing a visitor will see. |
| 6 | + |
| 7 | +# Project Setup Instructions |
| 8 | +## Working with the layout |
| 9 | + |
| 10 | + - Don't touch the psm1 file |
| 11 | + - Place functions you export in `functions/` (can have subfolders) |
| 12 | + - Place private/internal functions invisible to the user in `internal/functions` (can have subfolders) |
| 13 | + - Don't add code directly to the `postimport.ps1` or `preimport.ps1`. |
| 14 | + Those files are designed to import other files only. |
| 15 | + - When adding files you load during `preimport.ps1`, be sure to add corresponding entries to `filesBefore.txt`. |
| 16 | + The text files are used as reference when compiling the module during the build script. |
| 17 | + - When adding files you load during `postimport.ps1`, be sure to add corresponding entries to `filesAfter.txt`. |
| 18 | + The text files are used as reference when compiling the module during the build script. |
| 19 | + |
| 20 | +## Setting up CI/CD |
| 21 | + |
| 22 | +> To create a PR validation pipeline, set up tasks like this: |
| 23 | +
|
| 24 | + - Install Prerequisites (PowerShell Task; VSTS-Prerequisites.ps1) |
| 25 | + - Validate (PowerShell Task; VSTS-Validate.ps1) |
| 26 | + - Publish Test Results (Publish Test Results; NUnit format; Run no matter what) |
| 27 | + |
| 28 | +> To create a build/publish pipeline, set up tasks like this: |
| 29 | +
|
| 30 | + - Install Prerequisites (PowerShell Task; VSTS-Prerequisites.ps1) |
| 31 | + - Validate (PowerShell Task; VSTS-Validate.ps1) |
| 32 | + - Build (PowerShell Task; VSTS-Build.ps1) |
| 33 | + - Publish Test Results (Publish Test Results; NUnit format; Run no matter what) |
0 commit comments