see changelog for v0.7.0

jdhitsolutions · Oct 22, 2018 · 200347a · 200347a
1 parent 8a58d90
commit 200347a
Show file tree

Hide file tree

Showing 10 changed files with 240 additions and 110 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -0,0 +1,66 @@
+# Change log for PSReleaseTools
+
+## v0.7.0
+
++ Added switch parameter on `Get-PSReleaseAsset` to only get x64 versions
++ Added an option to display current release summary as a markdown document
++ help updates
++ file cleanup for the PowerShell Gallery
++ fixed license
+
+## v0.6.1
+
++ Added code to fix TLS issue with GitHub (Issue #5)
+
+## v0.6.0
+
++ Updated to support GA for PowerShell 6 (Issue #4)
++ Changed Save-PSReleaseAsset Name parameter to Family
++ Modified Family values
++ Updated documentation
++ Updated screen shots and README.md
+
+## v0.5.1.0
+
++ added asset support for SUSE and AppImage
++ minor changes to help documentation
++ updated Pester tests
+
+## v0.5.0.0
+
++ modified download to pull file hashes from summary
++ and compare them to downloaded files. This is BREAKING CHANGE.
++ Updated Get-PSReleaseAsset to include the SHA256 hash
++ Updated help
++ updated README
+
+## v0.4.0.2
+
++ fixed semantic versioning in the manifest
+
+## v0.4.0.1
+
++ Changed to semantic versioning
+
+## v0.4.0
+
++ updated author name in manifest
++ Added Get-PSReleaseCurrent
++ Updated help
+
+## v0.3.0
+
++ Renamed Save-PSRelease to Save-PSReleaseAsset for consistency (Issue #1)
++ Updated documentation
++ Updated manifest
++ Published to PSGallery
+
+## v0.2.0
+
++ Added external documentation
+
+## v0.1.0
+
++ Initial module release
++ updated license copyright
++ updated README
diff --git a/Changelog.txt b/Changelog.txt
diff --git a/Docs/Get-PSReleaseAsset.md b/Docs/Get-PSReleaseAsset.md
@@ -8,23 +8,26 @@ schema: 2.0.0
 # Get-PSReleaseAsset
 
 ## SYNOPSIS
+
 Get PowerShell release assets.
 
 ## SYNTAX
 
-```
-Get-PSReleaseAsset [[-Family] <String[]>] [<CommonParameters>]
+```yaml
+Get-PSReleaseAsset [[-Family] <String[]>] [-Only64Bit] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
+
 Use this command to get details about the different PowerShell release assets. The default is to get all assets but you can limit results to a particular family like Windows or Ubuntu.
 
 This command will not download the file but allow you to look at the details. You can pipe these results to Save-PSReleaseAsset to download.
 
 ## EXAMPLES
 
 ### EXAMPLE 1
-```
+
+```powershell
 PS C:\> Get-PSReleaseAsset -Family Rhel
 
 FileName      : powershell-6.0.0-1.rhel.7.x86_64.rpm
@@ -39,7 +42,8 @@ DownloadCount : 230
 ```
 
 ### EXAMPLE 2
-```
+
+```powershell
 PS C:\> Get-PSReleaseAsset -Family ubuntu | Save-PSReleaseAsset -Path D:\PS6 -whatif
 What if: Performing the operation "Downloading https://github.com/PowerShell/PowerShell/releases/download/v6.0.0/powershell_6.0.0-1.ubuntu.14.04_amd64.deb" on target "D:\PS6\powershell_6.0.0-1.ubuntu.14.04_amd64.deb".
 What if: Performing the operation "Downloading https://github.com/PowerShell/PowerShell/releases/download/v6.0.0/powershell_6.0.0-1.ubuntu.16.04_amd64.deb" on target "D:\PS6\powershell_6.0.0-1.ubuntu.16.04_amd64.deb".
@@ -51,13 +55,14 @@ Run the command without -Whatif to actually download the Ubuntu related files an
 ## PARAMETERS
 
 ### -Family
+
 Limit search to a particular platform.
 
 ```yaml
 Type: String[]
 Parameter Sets: (All)
 Aliases:
-Accepted values: Rhel,Raspbian,Ubuntu,Debian,Windows,AppImage,Arm,MacOS
+Accepted values: Rhel, Raspbian, Ubuntu, Debian, Windows, AppImage, Arm, MacOS
 
 Required: False
 Position: 0
@@ -66,7 +71,24 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -Only64Bit
+
+Only display 64bit assets.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### CommonParameters
+
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
@@ -78,8 +100,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ### System.Object
 
 ## NOTES
-Learn more about PowerShell:
-http://jdhitsolutions.com/blog/essential-powershell-resources/
+
+Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/
 
 ## RELATED LINKS
 

diff --git a/Docs/Get-PSReleaseCurrent.md b/Docs/Get-PSReleaseCurrent.md
@@ -8,45 +8,49 @@ schema: 2.0.0
 # Get-PSReleaseCurrent
 
 ## SYNOPSIS
+
 Get the current PowerShell v6 release
 
 ## SYNTAX
 
-```
+```yaml
 Get-PSReleaseCurrent [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-This command will query the GitHub repository for the latest release and write an object to the pipeline. 
 
-If you are running v6 the LocalVersion property will reflect the GitCommitID so you can accurately compare and determine if you need to update.
+This command will query the GitHub repository for the latest release and write an object to the pipeline. If you are running v6 the LocalVersion property will reflect the GitCommitID so you can accurately compare and determine if you need to update.
 
 ## EXAMPLES
 
 ### Example 1
-```
+
+```powershell
 PS C:\> Get-PSReleaseCurrent
 
 Name                              Version Released             LocalVersion
 ----                              ------- --------             ------------
-v6.0.0 release of PowerShell Core v6.0.0  1/10/2018 5:21:29 PM 5.1.16299.98
+v6.1.0 Release of PowerShell Core v6.1.0  9/13/2018 9:49:59 PM 6.1.0
 ```
 
 This gets the current release from a Windows platform.
 
 ### Example 2
-```
+
+```powershell
 PS /home/me> Get-PSReleaseCurrent
-Name                              Version Released            LocalVersion
-----                              ------- --------            ------------
-v6.0.0 release of PowerShell Core v6.0.0  1/10/18 10:21:29 PM v6.0.0
+
+Name                              Version Released           LocalVersion
+----                              ------- --------           ------------
+v6.1.0 Release of PowerShell Core v6.1.0  9/13/18 9:49:59 PM 6.1.0
 ```
 
 This gets the current release from an Ubuntu platform.
 
 ## PARAMETERS
 
 ### CommonParameters
+
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
@@ -58,8 +62,8 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ### System.Object
 
 ## NOTES
-Learn more about PowerShell:
-http://jdhitsolutions.com/blog/essential-powershell-resources/
+
+Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/
 
 ## RELATED LINKS
 

diff --git a/Docs/Get-PSReleaseSummary.md b/Docs/Get-PSReleaseSummary.md
@@ -1,35 +1,38 @@
 ---
 external help file: PSReleaseTools-help.xml
-Module Name: PSReleaseTools
+Module Name: psreleasetools
 online version:
 schema: 2.0.0
 ---
 
 # Get-PSReleaseSummary
 
 ## SYNOPSIS
+
 Get information on latest PowerShell v6 release
 
 ## SYNTAX
 
-```
-Get-PSReleaseSummary [<CommonParameters>]
+```yaml
+Get-PSReleaseSummary [-AsMarkdown] [<CommonParameters>]
 ```
 
 ## DESCRIPTION
-This command will query the PowerShell GitHub repository for the latest release information using the GitHub APIs. You do not need to have a GitHub account in order to use this command.
 
-The output is a text report.
+This command will query the PowerShell GitHub repository for the latest release information using the GitHub APIs. You do not need to have a GitHub account in order to use this command, although you may still reach an API limit if you run this command repeatedly in a short time frame.
+
+The default output is a text report but you have the the option to create a markdown version.
 
 ## EXAMPLES
 
 ### EXAMPLE 1
-```
+
+```powershell
 PS C:\> Get-PSReleaseSummary
 
 -----------------------------------------------------------
 Release  : v6.0.0
-Published: 01/10/2018 17:21:29 
+Published: 01/10/2018 17:21:29
 -----------------------------------------------------------
 ### Breaking changes
 
@@ -124,9 +127,34 @@ powershell_6.0.0-1.ubuntu.16.04_amd64.deb 1/10/2018 1:28:29 PM     50
 powershell_6.0.0-1.ubuntu.17.04_amd64.deb 1/10/2018 1:28:40 PM     50
 ```
 
+### EXAMPLE 2
+
+```powershell
+PS /home/jeff> get-psreleasesummary -AsMarkdown | show-markdown
+```
+
+Get the current release summary as markdown and use the Show-Markdown command in PowerShell Core to render the markdown in the console. Note that Show-Markdown may not render tables correctly.
+
 ## PARAMETERS
 
+### -AsMarkdown
+
+Create a markdown version of the report.
+
+```yaml
+Type: SwitchParameter
+Parameter Sets: (All)
+Aliases:
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### CommonParameters
+
 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
 
 ## INPUTS
@@ -138,12 +166,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 ### system.string
 
 ## NOTES
-Learn more about PowerShell:
-http://jdhitsolutions.com/blog/essential-powershell-resources/
+
+Learn more about PowerShell: http://jdhitsolutions.com/blog/essential-powershell-resources/
 
 ## RELATED LINKS
 
 [Get-PSReleaseCurrent]()
 
 [Invoke-Restmethod]()
-