Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Deyda/Evergreen-1

Create evergeen Windows image build scripts with the latest version and download links for applications
https://github.com/Deyda/Evergreen-1

Last synced: 8 days ago
JSON representation

Create evergeen Windows image build scripts with the latest version and download links for applications

Awesome Lists containing this project

README 

        
# About



[![License][license-badge]][license]

[![PowerShell Gallery Version][psgallery-version-badge]][psgallery]

[![PowerShell Gallery][psgallery-badge]][psgallery]

[![main build status][appveyor-badge]][appveyor-build]

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/767d96dec7bd40b69eb4665919d20f55)](https://www.codacy.com/manual/aaronparker/Evergreen?utm_source=github.com&utm_medium=referral&utm_content=aaronparker/Evergreen&utm_campaign=Badge_Grade)



Evergreen is a simple PowerShell module to return the latest version and download URLs for a set of common enterprise Windows applications. The module consists of a number of simple functions to use in scripts when performing several tasks including:



* Retrieve the latest version of a particular application when comparing against a version already installed or downloaded

* Return the URL for the latest version of the application if you need to download it locally for installation or deployment



![leaf by The Icon Z from the Noun Project](/img/EvergreenLeaf.png)



Via `Get-EvergreenApp` each Evergreen application returns at least two properties in the object is sends to the pipeline:



* `Version` - a string property that is the version number of the application. If you need these in a version format, cast them with `[System.Version]`

* `URI` - a string property that is the download location for the latest version of the application. These will be publicly available locations that provide installers in typically Windows installer formats, e.g., `exe`, `msi`. Some downloads may be in other formats, such as `zip` that will need to be extracted before install



## Documentation



For full documentation on the module, see the documentation located here: [https://stealthpuppy.com/Evergreen/index.html](https://stealthpuppy.com/Evergreen/index.html).



## Why



There are several community and commercial products that manage application deployment and updates already. This module isn't intended to compete against those. In fact, they can be complementary - for example, Evergreen can be used with the [Chocolatey Automatic Package Updater Module](https://www.powershellgallery.com/packages/AU/) to find the latest version of an application and then creating and submitting a Chocolatey package, or it can be used to create a [Windows Package Manager](https://github.com/microsoft/winget-cli) manifest (see a sample script here: [New-WinGetManifest.ps1](/tools/New-WinGetManifest.ps1)).



Evergreen's focus is on integration for PowerShell scripts to provide product version numbers and download URLs. Ideal for use with the Microsoft Deployment Toolkit or Microsoft Endpoint Configuration Manager for operating system deployment, creating applications packages in Microsoft Intune, or with [Packer](https://www.packer.io/) to create evergreen machine images in Azure or AWS.



## How



**Application version and download links are only pulled from official sources (vendor web site, GitHub, SourceForge etc.) and never a third party**.



Wherever possible, Evergreen uses an approach that returns at least the version number and download URI for applications programmatically - thus for each run an Evergreen function it should return the latest version and download link.



Scraping web pages to parse text and determine version strings and download URLs can be problematic when text in the page changes or the page is out of date. Evergreen instead uses approaches that should be less prone to failure by querying an API wherever possible. Evergreen uses several strategies to return the latest version of software:



1. Application update APIs - by using the same approach as the application itself, Evergreen can consistently return the latest version number and download URI - e.g. [Microsoft Edge](/Evergreen/Public/Get-MicrosoftEdge.ps1), [Mozilla Firefox](/Evergreen/Apps/Get-MozillaFirefox.ps1) or [Microsoft OneDrive](/Evergreen/Apps/Get-MicrosoftOneDrive.ps1). [Fiddler](https://www.telerik.com/fiddler) can often be used to find where an application queries for updates

2. Repository APIs - repo hosts including GitHub and SourceForge have APIs that can be queried to return application version and download links - e.g. [Atom](/Evergreen/Apps/Get-Atom.ps1), [Notepad++](/Evergreen/Apps/Get-NotepadPlusPlus.ps1) or [WinMerge](/Evergreen/Apps/Get-WinMerge.ps1)

3. Web page queries - often a vendor download pages will include a query when listing versions and download links - this avoids page scraping. Evergreen can mimic this approach to return application download URLs; however, this approach is likely to fail if the vendor changes how their pages work - e.g. [Microsoft FSLogix Apps]((/Evergreen/Apps/Get-MicrosoftFSLogixApps.ps1)) or [Zoom]((/Evergreen/Apps/Get-Zoom.ps1))



## PowerShell Support



Evergreen supports Windows PowerShell 5.1 and PowerShell 7.0+. Evergreen should work on PowerShell Core 6.x; however, we are not actively testing on that version of PowerShell, so support cannot be guaranteed.



## Who



This module is maintained by the following community members



* Aaron Parker, [@stealthpuppy](https://twitter.com/stealthpuppy)

* Bronson Magnan, [@CIT_Bronson](https://twitter.com/CIT_Bronson)

* Trond Eric Haarvarstein, [@xenappblog](https://twitter.com/xenappblog)



## Versioning



The module uses a version notation that follows: YearMonth.Build. It is expected that the module will have changes on a regular basis, so the version numbering is intended to make it as simple as possible to understand when the last update was made. See the [CHANGELOG](https://stealthpuppy.com/Evergreen/changelog.html) for details on changes introduced in each version.



## Installing the Module



### Install from the PowerShell Gallery



The Evergreen module is published to the PowerShell Gallery and can be found here: [Evergreen](https://www.powershellgallery.com/packages/Evergreen/). This is the best way to install Evergreen.



The module can be installed from the gallery with:



```powershell

Install-Module -Name Evergreen

Import-Module -Name Evergreen

```



#### Updating the Module



If you have installed a previous version of the module from the gallery, you can install the latest update with `Update-Module` and the `-Force` parameter:



```powershell

Update-Module -Name Evergreen -Force

```



### Manual Installation from the Repository



The module can be downloaded from the [GitHub source repository](https://github.com/aaronparker/Evergreen) and includes the module in the `Evergreen` folder. The folder needs to be installed into one of your PowerShell Module Paths. To see the full list of available PowerShell Module paths, use `$env:PSModulePath.split(';')` in a PowerShell console.



Common PowerShell module paths include:



* Current User: `%USERPROFILE%\Documents\WindowsPowerShell\Modules\`

* All Users: `%ProgramFiles%\WindowsPowerShell\Modules\`

* OneDrive: `$env:OneDrive\Documents\WindowsPowerShell\Modules\`



To install from the repository



1. Download the `main branch` to your workstation

2. Copy the contents of the Evergreen folder onto your workstation into the desired PowerShell Module path

3. Open a Powershell console with the Run as Administrator option

4. Run `Set-ExecutionPolicy` using the parameter `RemoteSigned` or `Bypass`

5. Unblock the files with `Get-ChildItem -Path  -Recurse | Unblock-File`



Once installation is complete, you can validate that the module exists by running `Get-Module -ListAvailable Evergreen`. To use the module, load it with:



```powershell

Import-Module Evergreen

```



[appveyor-badge]: https://img.shields.io/appveyor/ci/aaronparker/Evergreen/main.svg?style=flat-square&logo=appveyor

[appveyor-build]: https://ci.appveyor.com/project/aaronparker/Evergreen

[psgallery-badge]: https://img.shields.io/powershellgallery/dt/Evergreen.svg?style=flat-square

[psgallery]: https://www.powershellgallery.com/packages/Evergreen

[psgallery-version-badge]: https://img.shields.io/powershellgallery/v/Evergreen.svg?style=flat-square

[psgallery-version]: https://www.powershellgallery.com/packages/Evergreen

[github-release-badge]: https://img.shields.io/github/release/aaronparker/Evergreen.svg?style=flat-square

[github-release]: https://github.com/aaronparker/Evergreen/releases/latest

[license-badge]: https://img.shields.io/github/license/aaronparker/Evergreen.svg?style=flat-square

[license]: /LICENSE



---

leaf by The Icon Z from the Noun Project