VSTeam

Introduction

VSTeam is a PowerShell module with commands for accessing your Azure DevOps Server (previously named Visual Studio Team Foundation Server) 2017/2018 and Azure DevOps (previously named Visual Studio Team Services).

VSTeam module is also is 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

Pipeline Status

You can review the status of every stage of the pipeline below.

Stage	Status
Build
Linux Team Foundation Server 2017
macOS Team Foundation Server 2017
Windows Team Foundation Server 2017
Windows Team Foundation Server 2018
Windows Azure DevOps
Publish to PowerShell Gallery

The build for VSTeam is run on macOS, Linux and Windows to ensure there are no casing or other platform specific issues with the code.

On each platform unit tests are run.

During the release the module is installed on macOS, Linux and Window and tested against Azure DevOps Server and Azure DevOps before being published to the PowerShell Gallery.

Requirements

Windows PowerShell 5.0 or newer.
PowerShell Core.

Module Dependencies

Building Module

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 _*.json files in the repository.

The JSON files must be in the following format:

{
   "outputFile": "vsteam.functions.ps1",
   "fileType": "functions",
   "files": [
      "./Private/*.ps1",
      "./Public/*.ps1"
   ]
}

The final module is stored in a dist folder by default. You can override this folder by using the -outputDir parameter to the Build-Module.ps1 script.

To generate the help add the -buildHelp switch parameter.

You can also use the -installDep switch parameter to install all the module dependencies to bootstrap your development.

Contributors

Guidelines

Change Log

Maintainers

Donovan Brown - @DonovanBrown

License

This project is licensed under the MIT License.

eosfor / vsteam