diff --git a/AU/Plugins/Gist.ps1 b/AU/Plugins/Gist.ps1 index 6a62343e..e53fb5a0 100644 --- a/AU/Plugins/Gist.ps1 +++ b/AU/Plugins/Gist.ps1 @@ -1,6 +1,14 @@ # Author: Miodrag Milic -# Last Change: 07-Nov-2016. - +# Last Change: 10-Nov-2016. +<# +.SYNOPSIS + Create update history as markdown report using git commit log. + +.DESCRIPTION + Shows one date per line and all of the packages pushed to the Chocolatey community repository during that day. + First letter of the package name links to report (produced by the Report plugin), the rest links to actuall + commit (produced by the Git plugin). +#> param( $Info, diff --git a/AU/Plugins/History.ps1 b/AU/Plugins/History.ps1 index 624d90c3..bd375fe6 100644 --- a/AU/Plugins/History.ps1 +++ b/AU/Plugins/History.ps1 @@ -1,10 +1,25 @@ # Author: Miodrag Milic # Last Change: 10-Nov-2016. +<# +.SYNOPSIS + Create update history as markdown report + +.DESCRIPTION + Shows one date per line and all of the packages pushed to the Chocolatey community + repository during that day. First letter of the package name links to report + (produced by the Report plugin), the rest links to the actuall commit (produced by the Git plugin). +#> param( $Info, + + #Number of dates to show in the report $Lines=30, + + #Github user repository, used to create commit links $Github_UserRepo = 'chocolatey/chocolatey-coreteampackages', + + #File path where to save the markdown report $Path = "UpdateHistory.md" ) diff --git a/AU/Plugins/Report.ps1 b/AU/Plugins/Report.ps1 index 5f7c7206..af72f860 100644 --- a/AU/Plugins/Report.ps1 +++ b/AU/Plugins/Report.ps1 @@ -1,10 +1,24 @@ # Author: Miodrag Milic -# Last Change: 24-Sep-2016. +# Last Change: 10-Nov-2016. +<# +.SYNOPSIS + Create different types of reports about the current run. + +.DESCRIPTION + The plugin saves state of all packages in a file that can be used locally or + uploaded via other plugins to remote (such as Gist or Mail). +#> param( $Info, + + # Type of the report, currently 'markdown' or 'text' [string] $Type = 'markdown', + + # Path where to save the report [string] $Path = 'Update-AUPackages.md', + + # Report parameters [HashTable] $Params ) diff --git a/CHANGELOG.md b/CHANGELOG.md index 680f9587..3bfc3090 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ - `Update-AUPackages` - New parameters for markdown report - `IconSize` and `NoIcons`. Icons are now shown by default. - New plugin `History` that creates markdown report of package updates grouped by dates. + - Plugins documentation updated. - Refactoring ### Bugfixes