functions/Get-DbatoolsChangeLog.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
function Get-DbatoolsChangeLog {
    <#
    .SYNOPSIS
        Opens the link to our online change log
 
    .DESCRIPTION
        Opens the link to our online change log. To see the local changelog instead, use the Local parameter.
 
    .PARAMETER Local
        Return the local change log to the console
 
    .PARAMETER EnableException
        By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
        This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
        Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.
 
    .NOTES
        Tags: changelog
        Author: Chrissy LeMaire (@cl), netnerds.net
 
        Website: https://dbatools.io
        Copyright: (c) 2018 by dbatools, licensed under MIT
        License: MIT https://opensource.org/licenses/MIT
 
    .LINK
        https://dbatools.io/Get-DbatoolsChangeLog
 
    .EXAMPLE
        Get-DbatoolsChangeLog
 
        Opens a browser to our online changelog
 
    .EXAMPLE
        Get-DbatoolsChangeLog -Local
 
        Returns the content from changelog.md
    #>

    [CmdletBinding()]
    param (
        [switch]$Local,
        [switch]$EnableException
    )

    try {
        if (-not $Local) {
            Start-Process "https://github.com/sqlcollaborative/dbatools/blob/development/changelog.md"
        } else {
            $releasenotes = Get-Content $script:PSModuleRoot\changelog.md -Raw

            if ($Local) {
                ($releasenotes -Split "##Local")[0]
            } else {
                $releasenotes
            }
        }
    } catch {
        Stop-Function -Message "Failure" -ErrorRecord $_
        return
    }
}