Skip to content

Commit 1c4538a

Browse files
committed
adding documentation for using Repo-Tasks module
1 parent f4a0448 commit 1c4538a

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

documentation/Repo-Tasks-Module.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Repo-Tasks Module #
2+
3+
###### Usage:
4+
5+
1. Start PS-VSPrompt.lnk (shortcut), this will start VS Dev Prompt in powershell
6+
2. Import-Module ./Repo-Tasks.psm1
7+
1. During import, we allow to load additional functions that users might want to use it in their session.
8+
2. If you have any userPreference.ps1 file under %userprofile%/psFiles directory, the module will try to load it by dot sourcing it.
9+
2. It will also honor environment variable $env:psuserpreferences and load .ps1 files from the location that is pointed by $env:psuserpreferences
10+
3. As long as you have exported all the functions that you need from your ps1 file using export-modulemember -function <name of function>. We deliberately do this to avoid polluting list of commands available (when you use Get-Command)
11+
3. Currently Repo-Tasks module supports following tasks:
12+
1. Set-TestEnvironment
13+
1. Will allow you create a test connection string required to setup test environment in order to run tests. More information about Test environment can be found [here](https://github.com/Azure/azure-powershell/blob/dev/documentation/Using-Azure-TestFramework.md "here")
14+
2. Start-Build
15+
1. Will allow you to kick off full build
16+
2. Or will allow you build for a particular scope (e.g. Start-Build -BuildScope ResourceManagment\Compute)
17+
3. Get-BuildScopes
18+
1. Will allow you to query and find existing build scopes that can be used to build.
19+
4. Invoke-CheckinTests
20+
1. Will build and run existing tests.
21+
22+
###Note:
23+
If you do not start your powershell session using PS-VSPrompt shortcut, you will not have access to all the environment variables that are set as part of VS Dev Command prompt.

0 commit comments

Comments
 (0)