VSTeam

PowerShell module to automate Azure DevOps

Explore the docs »

About the project |
Requirements |
Install |
Change Log |

Contribute |
Building Module |
Maintainers

VSTeam Install Example

About The Project

VSTeam is a PowerShell module with commands for accessing your Azure DevOps Server and Azure DevOps Services).

The VSTeam module is also a provider allowing users to navigate their Azure DevOps Server and Azure DevOps as a file system.

To get started you can visit this blog PowerShell I would like you to meet TFS and VSTS

Requirements

Windows PowerShell 5.0 or newer.

The following modules are dependencies of the VSTeam module:

Install

Install this module from the PowerShell Gallery

Install-Module -Name VSTeam -Repository PSGallery -Scope CurrentUser

Change Log

Look at the Change Log file or the release notes on the GitHub releases.

Contribute

Check the Guidelines if you want to contribute.

Building Module

To run build the script Build-Module.ps1. The script has the following parameters:

-outputDir 'C:\outputdir': The final module is stored in a dist folder by default. You can override this folder by using the parameter
-buildHelp: Building help is skipped by default to speed up your inner loop. Use this flag to include building the help
-installDep: By default the build will not install dependencies unless this switch is used
-ipmo: build module will be imported into session. IF a loaded module exists, it will be overwritten with the build version.
-analyzeScript: run the static code analyzer for the scripts with PSScriptAnalyzer
-runTests: runs the unit tests
-testName 'tests to filter': can be used to filter the unit test parts that should be run. Wildcards can be used! See the Pester documentation for a more elaborate explanation.
-codeCoverage: outputs the code coverage. Output by default is NUnit

Below are some examples on how to build the module locally. It is expected that your working directory is at the root of the repository.

Builds the module, installs needed dependencies, loads the module into the session and also builds the help.

.\Build-Module.ps1 -installDep -ipmo -buildHelp

about module size

In an effort to reduce the module size this repository contains two scripts Build-Module.ps1 and Merge-File.ps1 that merges similar files into a single file. The files in the formats folder are merged into vsteam.format.ps1xml. The files in the classes folder are merged into vsteam.classes.ps1. The functions from the Private and Public folders are merged into vsteam.functions.ps1. Finally all the files in the types folder are merged into vsteam.types.ps1xml. The order of the files being merged can be controlled by the config.json files in the repository.

The JSON config file must be in the following format:

JSON
{
   "types" : {
      "outputFile": "vsteam.types.ps1xml",
      "path": "./Source/types/",
      "fileType": "types",
      "files": [
         "*.ps1xml"
      ]
   },
   "functions" : {
      "outputFile": "vsteam.functions.ps1",
      "path": "./Source/",
      "fileType": "functions",
      "files": [
         "./Private/*.ps1",
         "./Public/*.ps1"
      ]
   },
   "formats": {
      "outputFile": "vsteam.format.ps1xml",
      "path": "./Source/formats/",
      "fileType": "formats",
      "files": [
         "vsteam_lib.TaskGroup.TableView.ps1xml"
      ]
   }
}

Run Tests Locally

Runs all unit tests and executes the static code analysis.

.\Build-Module.ps1 -runTests -codeCoverage -analyzeScript

Runs the tests, but executes only the unit tests that have the description “workitems” for the logically grouped unit tests. This can be used if you only want to test a portion of your unit tests.

.\Build-Module.ps1 -runTests -testName workitems

Run Tests in Docker

You can run your unit tests also locally and cross-platform in a standardized environment.

Maintainers

License

This project is licensed under the MIT License.