From 696bf40a454bebc3848c125c1ce41bd1afe66b49 Mon Sep 17 00:00:00 2001 From: Miodrag Milic Date: Sun, 29 Oct 2017 19:28:23 +0100 Subject: [PATCH] docs for GitReleases --- AU/Plugins/GitReleases.ps1 | 4 ++++ CHANGELOG.md | 1 + Plugins.md | 4 ++-- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/AU/Plugins/GitReleases.ps1 b/AU/Plugins/GitReleases.ps1 index 70127229..118fc453 100644 --- a/AU/Plugins/GitReleases.ps1 +++ b/AU/Plugins/GitReleases.ps1 @@ -1,6 +1,10 @@ # Author: Kim Nordmo # Last Change: 29-Oct-2017. +<# +.SYNOPSIS + Creates Github release for updated packages +#> param( $Info, diff --git a/CHANGELOG.md b/CHANGELOG.md index dbbbf125..b1c71edf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,7 @@ - `au_BeforeUpdate` and `au_AfterUpdate` now provide parameter `Package` of type `[AUPackage]` which you can use to modify Nuspec data. - Added new function `Set-DescriptionFromReadme` that is called automatically when README.md is present in the package folder ([#85](https://github.com/majkinetor/au/issues/85)). See [documentation](README.md#automatic-package-description-from-readmemd). +- New plugin: [GitReleases](https://github.com/majkinetor/au/blob/master/AU/Plugins/GitReleases.ps1) ## 2017.8.30 diff --git a/Plugins.md b/Plugins.md index 8976811c..38269b74 100644 --- a/Plugins.md +++ b/Plugins.md @@ -24,9 +24,9 @@ To set up plugin to create gist under your user name you need to give it your gi ## [GitReleases](https://github.com/majkinetor/au/blob/master/AU/Plugins/GitReleases.ps1) -**Prevent tags from being built** +**Creates Github release for updated packages**. -It is recommended to add the following line `skip_tags: true` in the `appveyor.yml` file to prevent tags from being built. While it may not be necessary, this is used to prevent packages from being submitted again when `[AU]` or `[PUSH]` is being used in the commit header message. +* It is recommended to add the following line `skip_tags: true` in the `appveyor.yml` file to prevent tags from being built. While it may not be necessary, this is used to prevent packages from being submitted again when `[AU]` or `[PUSH]` is being used in the commit header message. ## [History](https://github.com/majkinetor/au/blob/master/AU/Plugins/History.ps1)