Skip to content
This repository has been archived by the owner on Oct 25, 2022. It is now read-only.

Commit

Permalink
Plugin docs updated and synced with wiki.
Browse files Browse the repository at this point in the history
  • Loading branch information
majkinetor committed Nov 10, 2016
1 parent 3c77aef commit cbdddc8
Show file tree
Hide file tree
Showing 4 changed files with 41 additions and 3 deletions.
12 changes: 10 additions & 2 deletions AU/Plugins/Gist.ps1
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
# Author: Miodrag Milic <[email protected]>
# 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,

Expand Down
15 changes: 15 additions & 0 deletions AU/Plugins/History.ps1
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
# Author: Miodrag Milic <[email protected]>
# 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"
)

Expand Down
16 changes: 15 additions & 1 deletion AU/Plugins/Report.ps1
Original file line number Diff line number Diff line change
@@ -1,10 +1,24 @@
# Author: Miodrag Milic <[email protected]>
# 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
)

Expand Down
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit cbdddc8

Please sign in to comment.