Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/RamblingCookieMonster/PSDeploy
Simple PowerShell based deployments
https://github.com/RamblingCookieMonster/PSDeploy
build build-automation build-pipelines ci-cd continuous-delivery continuous-deployment powershell powershell-modules
Last synced: about 2 months ago
JSON representation
Simple PowerShell based deployments
- Host: GitHub
- URL: https://github.com/RamblingCookieMonster/PSDeploy
- Owner: RamblingCookieMonster
- License: mit
- Created: 2015-08-07T00:02:52.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2021-01-13T22:00:55.000Z (over 3 years ago)
- Last Synced: 2024-05-01T13:26:06.150Z (5 months ago)
- Topics: build, build-automation, build-pipelines, ci-cd, continuous-delivery, continuous-deployment, powershell, powershell-modules
- Language: PowerShell
- Homepage: http://ramblingcookiemonster.github.io/PSDeploy-Take-Two/
- Size: 1.27 MB
- Stars: 343
- Watchers: 25
- Forks: 69
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Contributing: Contributing.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-powershell - PSDeploy - Simple PowerShell based deployments. 🚧 (🛠️ Build Tools)
- jimsghstars - RamblingCookieMonster/PSDeploy - Simple PowerShell based deployments (PowerShell)
README
[](https://ci.appveyor.com/project/RamblingCookieMonster/psdeploy/branch/master) [](http://psdeploy.readthedocs.org/en/latest/?badge=latest)
PSDeploy
========
PSDeploy is a quick and dirty module to simplify PowerShell based deployments.
The idea is that you write a *.psdeploy.ps1 deployment configuration with sources and targets, and PSDeploy will deploy these.
Suggestions, pull requests, and other contributions would be more than welcome! See the [contributing guidlines](Contributing.md) for more info.
## Deployments
Invoking PSDeploy is very similar to running Invoke-Pester. Here's an example, Some.PSDeploy.ps1
```powershell
Deploy ActiveDirectory1 { # Deployment name. This needs to be unique. Call it whatever you want
By Filesystem { # Deployment type. See Get-PSDeploymentType
FromSource 'Tasks\AD\Some-ADScript.ps1', # One or more sources to deploy. Absolute, or relative to deployment.yml parent
'Tasks\AllOfThisDirectory'
To '\\contoso.org\share$\Tasks' # One or more destinations to deploy the sources to
Tagged Prod # One or more tags you can use to restrict deployments or queries
WithOptions @{
Mirror = $True # If the source is a folder, triggers robocopy purge. Danger
}
}
}
```
Let's pretend Some.PSDeploy.ps1 lives in C:\Git\Misc\Deployments. Here's what happens when we invoke a deployment:
```powershell
Invoke-PSDeploy -Path C:\Git\Misc
```
* We search for all *.*Deploy.ps1 or *PSDeploy.ps1 files under C:\Git\Misc, and find Some.PSDeploy.ps1. In this case, we have two resulting deployments, Some-ADScript.ps1, and AllOfThisDirectory
* We check the deployment type. Filesystem.
* We invoke the script associated with Filesystem Deployments, passing in the two deployments
* Relative paths are resolved by joining paths with C:\Git\Misc
* C:\Git\Misc\Tasks\AD\Some-ADScript.ps1 is copied to \\contoso.org\share$\Tasks with Copy-Item
* C:\Git\Misc\Tasks\AD\Tasks\AllOfThisDirectory is copied to \\contoso.org\share$\Tasks with robocopy, using /XO /E /PURGE (we only purge if mirror is true)
## Initial PSDeploy setup
```powershell
# One time setup
# Download the repository
# Unblock the zip
# Extract the PSDeploy folder to a module path (e.g. $env:USERPROFILE\Documents\WindowsPowerShell\Modules\)
#Simple alternative, if you have PowerShell 5, or the PowerShellGet module:
Install-Module PSDeploy
# Import the module.
Import-Module PSDeploy # Alternatively, Import-Module \\Path\To\PSDeploy
# Get commands in the module
Get-Command -Module PSDeploy
# Get help for the module and a command
Get-Help about_PSDeploy
Get-Help Invoke-PSDeploy -full
```
## More Information
The [PSDeploy docs](http://psdeploy.readthedocs.org/) will include more information, including:
* Examples for different DeploymentTypes - will try to keep these in sync with new types when they are added
* Illustrations of features like tags and dependencies
* Common scenarios (todo)
* How to write new PSDeploy DeploymentTypes
* Details on the PSDeploy Configuration Files
The blog posts ([one](http://ramblingcookiemonster.github.io/PSDeploy/), [two](http://ramblingcookiemonster.github.io/PSDeploy-Take-Two/)), and [three](http://ramblingcookiemonster.github.io/PSDeploy-Inception/) will become out of date over time, but may include helpful details
## Notes
Thanks go to:
* Scott Muc for [PowerYaml](https://github.com/scottmuc/PowerYaml), which we borrow for YAML parsing
* Boe Prox for [Get-FileHash](http://learn-powershell.net/2013/03/25/use-powershell-to-calculate-the-hash-of-a-file/), which we borrow for downlevel hash support in the deployment scripts
* Michael Greene, for the idea of using a DSL similar to Pester
* Folks writing new PSDeploy deployment types and contributing in other ways - thank you!