README.md

Important Note

This version of the module is currently not in development. We are no longer accepting any pull requests to this repository and are not planning any future releases. If you have a question, or are seeing an unexpected behavior from PowerShellGet 2.x or below please open an issue in this repository. We are tracking the on-going development of the new version of this module in the PowerShell/PowerShellGet repository. The PowerShell/PowerShellGet repository is also the best place to open any feature requests for this module.

Introduction

PowerShellGet is a PowerShell module with commands for discovering, installing, updating and publishing the PowerShell artifacts like Modules, DSC Resources, Role Capabilities and Scripts.

PowerShellGet module is also integrated with the PackageManagement module as a provider, users can also use the PackageManagement cmdlets for discovering, installing and updating the PowerShell artifacts like Modules and Scripts.

Build status

Development branch

OS - PS Version	Build Status
AppVeyor (Windows - PS 4.0)
AppVeyor (Windows - PS 5.1)
AppVeyor (Windows - PS 6.0.0+)
Travis CI (Linux - PS 6.0.0+)
Travis CI (MacOS - PS 6.0.0+)

Master branch

OS - PS Version	Build Status
AppVeyor (Windows - PS 4.0)
AppVeyor (Windows - PS 5.1)
AppVeyor (Windows - PS 6.0.0+)
Travis CI (Linux - PS 6.0.0+)
Travis CI (MacOS - PS 6.0.0+)

Daily Build status

Development branch

OS - PS Version	Build Status
AppVeyor (Windows - PS 4.0)
AppVeyor (Windows - PS 5.1)
AppVeyor (Windows - PS 6.0.0+)
Travis CI (Linux - PS 6.0.0+)
Travis CI (MacOS - PS 6.0.0+)

Documentation

Click here

Requirements

• Windows PowerShell 3.0 or newer.
• PowerShell Core.

Module Dependencies

• PackageManagement module

Get PowerShellGet Module

Please refer to our documentation for the up-to-date version on how to get the PowerShellGet Module.

Get PowerShellGet Source

Steps

• Obtain the source
  • Download the latest source code from the release page (https://github.com/PowerShell/PowerShellGet/releases) OR
  • Clone the repository (needs git)

  git clone https://github.com/PowerShell/PowerShellGet

• Navigate to the source directory

cd path/to/PowerShellGet

• Import the module

Import-Module src/PowerShellGet

Local Development

Visual Studio Code:-

1. Open VSCode choosing "Run as Administrator"
2. Select Terminal>Run Task>Install Dependencies
3. Select Terminal>Run Task>Build and Import Module

for subsequent changes you can just run 'Build and Import Module' or press ctrl + shift + B

Standard PowerShell:-

1. Open an administrative PowerShell prompt
2. Run the following commands

Import-Module "$ClonePath\tools\build.psm1"
Install-Dependencies
Install-DevelopmentModule

This will take the published module from ./dist and install it into the powershell module path under the current version of PowerShellGet apending 9999 to the version number.

An explicit or implicit (such as when the test suite is invoked) import of the PowerShell get module will ensure the module version under development gets loaded.

It is therefore easy to see with Get Module that the version under development is loaded, like this:-

To remove this module and revert to the production PowerShellGallery published version, simply remove the folder from the module path. (if running VSCode select Terminal>Run Task>Remove Development Module).

Running Tests

VSCode

You can run the test task Terminal>Run Task>Run Full Test Suite

Non VSCode

Pester-based PowerShellGet Tests are located in <branch>/PowerShellGet/Tests folder.

Run following commands in PowerShell Console with Administrator privileges.

Import-Module "$ClonePath\tools\build.psm1"
Install-Dependencies
Invoke-PowerShellGetTest

Contributing to PowerShellGet

You are welcome to contribute to this project. There are many ways to contribute:

• Submit a bug report via Issues. For a guide to submitting good bug reports, please read Painless Bug Tracking.
• Read the documentation on contributing to open source and forking.
• Verify fixes for bugs.
• Submit your fixes for a bug. Before submitting, please make sure you have:
  • Performed code reviews of your own
  • Updated the test cases if needed
  • Run the test cases to ensure no feature breaks or test breaks
  • Added the test cases for new code
• Submit a feature request.
• Help answer questions in the discussions list.
• Submit test cases.
• Tell others about the project.
• Tell the developers how much you appreciate the product!

You might also read these two blog posts about contributing code: Open Source Contribution Etiquette by Miguel de Icaza, and Don’t “Push” Your Pull Requests by Ilya Grigorik.

Before submitting a feature or substantial code contribution, please discuss it with the Windows PowerShell team via Issues, and ensure it follows the product roadmap. Note that all code submissions will be rigorously reviewed by the Windows PowerShell Team. Only those that meet a high bar for both quality and roadmap fit will be merged into the source.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.