Merge branch 'docs/GH-134' into develop

Author: gep13

.markdownlint.json

@@ -0,0 +1,3 @@
+{
+    "MD026": false
+}

.vscode/settings.json

@@ -0,0 +1,13 @@
+{
+    "editor.rulers": [80],
+    "cSpell.words": [
+        "addasset",
+        "buildartifacts",
+        "choco",
+        "gitreleasemanager",
+        "nupkg",
+        "psake",
+        "releasenotes",
+        "showconfig"
+    ]
+}

Source/GitReleaseManager/Configuration/Config.cs

@@ -21,7 +21,7 @@ public Config()
                                   FooterIncludesMilestone = false,
                                   MilestoneReplaceText = string.Empty,
                                   IncludeShaSection = false,
-                                  ShaSectionHeading = "__SHA256 Hashes of the release artifacts__",
+                                  ShaSectionHeading = "SHA256 Hashes of the release artifacts",
                                   ShaSectionLineFormat = "- `{1}\t{0}`"
             };
 

Source/GitReleaseManager/Configuration/ConfigurationProvider.cs

@@ -84,7 +84,7 @@ private static void EnsureDefaultConfig(Config configuration)
         {
             if(configuration.Create.ShaSectionHeading == null)
             {
-                configuration.Create.ShaSectionHeading = "__SHA256 Hashes of the release artifacts__";
+                configuration.Create.ShaSectionHeading = "SHA256 Hashes of the release artifacts";
             }
 
             if(configuration.Create.ShaSectionLineFormat == null)

docs/input/docs/advanced.md

@@ -3,62 +3,106 @@ Order: 20
 Title: Advanced Workflow
 ---
 
-# Advanced Workflow
-
-In order to best understand the use case for GitReleaseManager let's take a look at an example workflow currently in use by the Chocolatey GUI project.
+In order to best understand the use case for GitReleaseManager let's take a look
+at an example workflow currently in use by the Chocolatey GUI project.
 
 :::{.alert .alert-info}
-Chocolatey GUI uses a number of concepts, for example, GitFlow, psake build script engine, AppVeyor Continuous Integration, as well as using GitReleaseManager.  In order to understand the usage of GitReleaseManager for this project, you sort of have to understand the entire process.  As a result, this walk-through steps you through the entire end to end process, which as a result, means it is quite lengthy.
+Chocolatey GUI uses a number of concepts, for example, GitFlow, psake build
+script engine, AppVeyor Continuous Integration, as well as using
+GitReleaseManager.  In order to understand the usage of GitReleaseManager for
+this project, you sort of have to understand the entire process.  As a result,
+this walk-through steps you through the entire end to end process, which as a
+result, means it is quite lengthy.
 :::
 
-# Chocolatey GUI
-[Chocolatey GUI](https://github.com/chocolatey/ChocolateyGUI) is an open source project, hosted on GitHub that makes use of GitReleaseManager to create and export it's release notes.  Before we can get into how GitReleaseManager is used, we need to take a look at how Chocolatey GUI is setup.
-
-## GitHub Setup
-  * All Issues are tracked using the[ GitHub Issues List](https://github.com/chocolatey/ChocolateyGUI/issues)
-  * Each Issue is assigned to a [project milestone](https://github.com/chocolatey/ChocolateyGUI/milestones)
-  * Each Issue is appropriately tagged using one of the [pre-defined labels](https://github.com/chocolatey/ChocolateyGUI/labels)
+## Chocolatey GUI
 
-## GitFlow
-  * Chocolatey GUI uses the [GitFlow Branching Model](http://nvie.com/posts/a-successful-git-branching-model/)
-  * [GitVersion](https://github.com/ParticularLabs/GitVersion) is used to determine the current version number, based on the current state of the repository, i.e. what branch is being worked on, and what tags have been assigned, and how many commits have been made to the repository
-
-## Build Artifacts
-Every build of Chocolatey GUI generates a number of Build Artifacts, these include:
-  * An MSI package for installing Chocolatey GUI
-  * A Chocolatey package to ease the installation of Chocolatey GUI
+[Chocolatey GUI](https://github.com/chocolatey/ChocolateyGUI) is an open source
+project, hosted on GitHub that makes use of GitReleaseManager to create and
+export it's release notes.  Before we can get into how GitReleaseManager is
+used, we need to take a look at how Chocolatey GUI is setup.
 
-## Continuous Integration
+### GitHub Setup
 
-  * Chocolatey GUI uses [AppVeyor](http://www.appveyor.com/) as it's Continuous Integration Server.
-  * Any time a **Pull Request** is created, an AppVeyor build is triggered, but no deployment of the build artifacts takes place
-  * Any time a commit is made into the **develop **branch, an AppVeyor build is triggered, and the build artifacts are deployed to the [MyGet Develop Feed](https://www.myget.org/feed/Packages/ghrm_develop)
-  * Any time a commit is made into the **master **branch, an AppVeyor build is triggered, and the build artifacts are deployed to the [MyGet Master Feed](https://www.myget.org/feed/Packages/ghrm_master)
-  * Any time a **tag **is applied to the repository, an AppVeyor build is triggered, and the build artifacts are deployed to [Chocolatey.org](https://chocolatey.org/) for public consumption.
+* All Issues are tracked using the [GitHub Issues List](https://github.com/chocolatey/ChocolateyGUI/issues)
+* Each Issue is assigned to a [project milestone](https://github.com/chocolatey/ChocolateyGUI/milestones)
+* Each Issue is appropriately tagged using one of the [pre-defined labels](https://github.com/chocolatey/ChocolateyGUI/labels)
 
-## Ok, so where does GitReleaseManager come into play?
+### GitFlow
 
-The role of GitReleaseManager really comes into play when moving between a **release** or **hotfix** branch and the **master **branch.
+* Chocolatey GUI uses the [GitFlow Branching Model](http://nvie.com/posts/a-successful-git-branching-model/)
+* [GitVersion](https://github.com/ParticularLabs/GitVersion) is used to
+determine the current version number, based on the current state of the
+repository, i.e. what branch is being worked on, and what tags have been
+assigned, and how many commits have been made to the repository
 
-Let's say you have done a bunch of work on the develop branch, you want to move all of that work into the master branch, via a release branch.  When you do this, you are effectively saying that the milestone that you were working on is almost ready for release.  It is at this point that you should really know, via the issues list, everything that is being included in the release, and now would seem like a great time to create some release notes.  And this is exactly what the build process for Chocolatey GUI does.  Let's break this down further...
+### Build Artifacts
 
-  * A **release **branch is created from **develop **branch
-  * The release branch is merged into master branch, triggering a build (with deployment to MyGet Master Feed).
-  * During this build, GitReleaseManager is executed, using the **create** command, and the version number which was provided by GitVersion, to create a set of release notes for this milestone - [source](https://github.com/chocolatey/ChocolateyGUI/blob/09b78495ebc9d334fedf351b021fd7e215c5cf87/BuildScripts/default.ps1#L687).
-  * This set of release notes is created in draft format, ready for review, in the GitHub UI.
-  * The build artifacts which have been deployed to MyGet Master Feed are tested
-  * The release notes are reviewed, and ensured to be correct
-  * Assuming that everything is verified to be correct, the draft release is then published through the GitHub UI, which creates a tag in the repository, triggering another AppVeyor build, this time with deployment to Chocolatey.org
-  * During this build, GitReleaseManager is executed using the **export** command, so that all release notes can be bundled into the application - [source](https://github.com/chocolatey/ChocolateyGUI/blob/09b78495ebc9d334fedf351b021fd7e215c5cf87/BuildScripts/default.ps1#L707)
-  * In addition, GitReleaseManager is executed using the **addasset** command to add the build artifacts to the GitHub release - [source](https://github.com/chocolatey/ChocolateyGUI/blob/09b78495ebc9d334fedf351b021fd7e215c5cf87/BuildScripts/default.ps1#L731)
-  * And finally, GitReleaseManager is executed using the **close** command to close the milestone associated with the release that has just been published - [source](https://github.com/chocolatey/ChocolateyGUI/blob/09b78495ebc9d334fedf351b021fd7e215c5cf87/BuildScripts/default.ps1#L753)
-
-The end result of this process can be seen [here](https://github.com/chocolatey/ChocolateyGUI/releases/tag/0.12.0).  This release included 218 commits, and 75 issues.  Personally, I simply wouldn't have created such a comprehensive set of release notes manually.  Instead, I would have written something like...
+Every build of Chocolatey GUI generates a number of Build Artifacts, these include:
 
-```
+* An MSI package for installing Chocolatey GUI
+* A Chocolatey package to ease the installation of Chocolatey GUI
+
+### Continuous Integration
+
+* Chocolatey GUI uses [AppVeyor](http://www.appveyor.com/) as it's Continuous Integration Server.
+* Any time a **Pull Request** is created, an AppVeyor build is triggered, but no
+deployment of the build artifacts takes place
+* Any time a commit is made into the **develop **branch, an AppVeyor build is
+triggered, and the build artifacts are deployed to the
+[MyGet Develop Feed](https://www.myget.org/feed/Packages/ghrm_develop)
+* Any time a commit is made into the **master **branch, an AppVeyor build is
+triggered, and the build artifacts are deployed to the
+[MyGet Master Feed](https://www.myget.org/feed/Packages/ghrm_master)
+* Any time a **tag **is applied to the repository, an AppVeyor build is
+triggered, and the build artifacts are deployed to
+[Chocolatey.org](https://chocolatey.org/) for public consumption.
+
+### Ok, so where does GitReleaseManager come into play?
+
+The role of GitReleaseManager really comes into play when moving between a
+**release** or **hotfix** branch and the **master **branch.
+
+Let's say you have done a bunch of work on the develop branch, you want to move
+all of that work into the master branch, via a release branch.  When you do
+this, you are effectively saying that the milestone that you were working on is
+almost ready for release.  It is at this point that you should really know, via
+the issues list, everything that is being included in the release, and now would
+seem like a great time to create some release notes.  And this is exactly what
+the build process for Chocolatey GUI does.  Let's break this down further...
+
+* A **release **branch is created from **develop **branch
+* The release branch is merged into master branch, triggering a build (with
+deployment to MyGet Master Feed).
+* During this build, GitReleaseManager is executed, using the **create**
+command, and the version number which was provided by GitVersion, to create a
+set of release notes for this milestone - [source](https://github.com/chocolatey/ChocolateyGUI/blob/09b78495ebc9d334fedf351b021fd7e215c5cf87/BuildScripts/default.ps1#L687).
+* This set of release notes is created in draft format, ready for review, in the
+GitHub UI.
+* The build artifacts which have been deployed to MyGet Master Feed are tested
+* The release notes are reviewed, and ensured to be correct
+* Assuming that everything is verified to be correct, the draft release is then
+published through the GitHub UI, which creates a tag in the repository,
+triggering another AppVeyor build, this time with deployment to Chocolatey.org
+* During this build, GitReleaseManager is executed using the **export** command,
+so that all release notes can be bundled into the application - [source](https://github.com/chocolatey/ChocolateyGUI/blob/09b78495ebc9d334fedf351b021fd7e215c5cf87/BuildScripts/default.ps1#L707)
+* In addition, GitReleaseManager is executed using the **addasset** command to
+add the build artifacts to the GitHub release - [source](https://github.com/chocolatey/ChocolateyGUI/blob/09b78495ebc9d334fedf351b021fd7e215c5cf87/BuildScripts/default.ps1#L731)
+* And finally, GitReleaseManager is executed using the **close** command to
+close the milestone associated with the release that has just been published - [source](https://github.com/chocolatey/ChocolateyGUI/blob/09b78495ebc9d334fedf351b021fd7e215c5cf87/BuildScripts/default.ps1#L753)
+
+The end result of this process can be seen
+[here](https://github.com/chocolatey/ChocolateyGUI/releases/tag/0.12.0).
+This release included 218 commits, and 75 issues.  Personally, I simply wouldn't
+have created such a comprehensive set of release notes manually.  Instead, I
+would have written something like...
+
+```text
 #0.12.0
 
 This release included lots of bug fixes, and tonnes of new features.  Enjoy!
 ```
 
-By leveraging GitVersion, and GitReleaseManager, and a small amount of process (which you are likely already doing), I hope you will agree that you can very easily create a comprehensive set of release notes for your application.
+By leveraging GitVersion, and GitReleaseManager, and a small amount of process
+(which you are likely already doing), I hope you will agree that you can very
+easily create a comprehensive set of release notes for your application.

docs/input/docs/commands/add-assets.md

@@ -3,24 +3,30 @@ Order: 20
 Title: Add Assets
 ---
 
-# Add Assets
-
-Once a draft set of release notes has been created, it is possible to add additional assets to the release using the addasset command.
+Once a draft set of release notes has been created, it is possible to add
+additional assets to the release using the addasset command.
 
 ## **Required Parameters**
 
-* `-u, --username`: The username to access GitHub with.  This can't be used when using the token parameter.
-* `-p, --password`: The password to access GitHub with.  This can't be used when using the token parameter.
-* `--token`: The access token to access GitHub with.  This can't be used when using the username and password parameters.
+* `-u, --username`: The username to access GitHub with.  This can't be used when
+using the token parameter.
+* `-p, --password`: The password to access GitHub with.  This can't be used when
+using the token parameter.
+* `--token`: The access token to access GitHub with.  This can't be used when
+using the username and password parameters.
 * `-o, --owner`: The owner of the repository.
 * `-r, --repository`: The name of the repository.
-* `-t, --tagName`: The name of the release (Typically this is the generated SemVer Version Number).
-* `-a, --assets`: Path(s) to the file(s) to include in the release.  This is a comma separated list of files to include
+* `-t, --tagName`: The name of the release (Typically this is the generated
+SemVer Version Number).
+* `-a, --assets`: Path(s) to the file(s) to include in the release.  This is a
+comma separated list of files to include
 
 ## **Optional Parameters**
 
-* `-d, -targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
-* `-l, -logFilePath`: Path to where log file should be created. Defaults to logging to console.
+* `-d, -targetDirectory`: The directory on which GitReleaseManager should be
+executed. Defaults to current directory.
+* `-l, -logFilePath`: Path to where log file should be created. Defaults to
+logging to console.
 
 ## **Notes**
 

docs/input/docs/commands/close.md

@@ -3,23 +3,28 @@ Order: 40
 Title: Close
 ---
 
-# Close
-
-Out of the box, publishing a release on GitHub does not close the milestone associated with the release.  This command, when executed, closes the specified milestone.
+Out of the box, publishing a release on GitHub does not close the milestone
+associated with the release.  This command, when executed, closes the specified
+milestone.
 
 ## **Required Parameters**
 
-* `-u, --username`: The username to access GitHub with.  This can't be used when using the token parameter.
-* `-p, --password`: The password to access GitHub with.  This can't be used when using the token parameter.
-* `--token`: The access token to access GitHub with.  This can't be used when using the username and password parameters.
+* `-u, --username`: The username to access GitHub with.  This can't be used when
+using the token parameter.
+* `-p, --password`: The password to access GitHub with.  This can't be used when
+using the token parameter.
+* `--token`: The access token to access GitHub with.  This can't be used when
+using the username and password parameters.
 * `-o, --owner`: The owner of the repository.
 * `-r, --repository`: The name of the repository.
 * `-m, --milestone`: The milestone to use.
 
 ## **Optional Parameters**
 
-* `-d, --targetDirectory`: The directory on which GitReleaseManager should be executed. Defaults to current directory.
-* `-l, --logFilePath`: Path to where log file should be created. Defaults to logging to console.
+* `-d, --targetDirectory`: The directory on which GitReleaseManager should be
+executed. Defaults to current directory.
+* `-l, --logFilePath`: Path to where log file should be created. Defaults to
+logging to console.
 
 ## **Notes**