/PsXLDeploy

Primary LanguagePowerShellApache License 2.0Apache-2.0

PsXLDeploy PowerShell module

PsXLDeploy is a PowerShell module that provides a wrapper for XLDeploy to allow easy and fast authenticated access to XLDeploy REST API in a scriptable and automatable manner.

Usage

Import-Module PsXLDeploy

Examples

Try and execute the sample scripts in the Examples folder against your local PsXLDeploy server to see all the Cmdlets in action or call help on any of the PsXLDeploy cmdlets.

Server and Authentication

# Set the target PsXLDeploy Server
Set-XLDConfig -Url 'http://localhost:8080'

# Set login credentials for further cmdlets
Set-XLDAuthentication -Credential (Get-Credential)

Documentation

Cmdlets and functions for PsXLDeploy have their own help PowerShell help, which you can read with help <cmdlet-name>.

Versioning

PsXLDeploy aims to adhere to Semantic Versioning 2.0.0.

Development

Pull requests are very welcome! Ideally create a topic branch for every separate change you make. For example:

  1. Fork the repo
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Make sure Invoke-Pester tests are passing with all your changes
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request

Authors

Created and maintained by [Marcel Bezemer] (marcel@beestig.nl).

License

Apache License, Version 2.0 (see LICENSE)

TODO

  • Sort casing throughout module
  • Make build general for use with appveryor
  • Make moduke available on psGallery