Skip to content

Commit 1cb9a83

Browse files
committed
(doc) Markdown lint fixes
1 parent 872be87 commit 1cb9a83

File tree

4 files changed

+40
-41
lines changed

4 files changed

+40
-41
lines changed

docs/input/docs/advanced.md

Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -3,62 +3,65 @@ Order: 20
33
Title: Advanced Workflow
44
---
55

6-
# Advanced Workflow
7-
86
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.
97

108
:::{.alert .alert-info}
119
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.
1210
:::
1311

14-
# Chocolatey GUI
12+
## Chocolatey GUI
13+
1514
[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.
1615

17-
## GitHub Setup
18-
* All Issues are tracked using the[ GitHub Issues List](https://github.com/chocolatey/ChocolateyGUI/issues)
19-
* Each Issue is assigned to a [project milestone](https://github.com/chocolatey/ChocolateyGUI/milestones)
20-
* Each Issue is appropriately tagged using one of the [pre-defined labels](https://github.com/chocolatey/ChocolateyGUI/labels)
16+
### GitHub Setup
17+
18+
* All Issues are tracked using the[ GitHub Issues List](https://github.com/chocolatey/ChocolateyGUI/issues)
19+
* Each Issue is assigned to a [project milestone](https://github.com/chocolatey/ChocolateyGUI/milestones)
20+
* Each Issue is appropriately tagged using one of the [pre-defined labels](https://github.com/chocolatey/ChocolateyGUI/labels)
21+
22+
### GitFlow
2123

22-
## GitFlow
23-
* Chocolatey GUI uses the [GitFlow Branching Model](http://nvie.com/posts/a-successful-git-branching-model/)
24-
* [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
24+
* Chocolatey GUI uses the [GitFlow Branching Model](http://nvie.com/posts/a-successful-git-branching-model/)
25+
* [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
26+
27+
### Build Artifacts
2528

26-
## Build Artifacts
2729
Every build of Chocolatey GUI generates a number of Build Artifacts, these include:
28-
* An MSI package for installing Chocolatey GUI
29-
* A Chocolatey package to ease the installation of Chocolatey GUI
3030

31-
## Continuous Integration
31+
* An MSI package for installing Chocolatey GUI
32+
* A Chocolatey package to ease the installation of Chocolatey GUI
33+
34+
### Continuous Integration
3235

33-
* Chocolatey GUI uses [AppVeyor](http://www.appveyor.com/) as it's Continuous Integration Server.
34-
* Any time a **Pull Request** is created, an AppVeyor build is triggered, but no deployment of the build artifacts takes place
35-
* 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)
36-
* 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)
37-
* 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.
36+
* Chocolatey GUI uses [AppVeyor](http://www.appveyor.com/) as it's Continuous Integration Server.
37+
* Any time a **Pull Request** is created, an AppVeyor build is triggered, but no deployment of the build artifacts takes place
38+
* 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)
39+
* 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)
40+
* 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.
3841

39-
## Ok, so where does GitReleaseManager come into play?
42+
### Ok, so where does GitReleaseManager come into play?
4043

4144
The role of GitReleaseManager really comes into play when moving between a **release** or **hotfix** branch and the **master **branch.
4245

4346
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...
4447

45-
* A **release **branch is created from **develop **branch
46-
* The release branch is merged into master branch, triggering a build (with deployment to MyGet Master Feed).
47-
* 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).
48-
* This set of release notes is created in draft format, ready for review, in the GitHub UI.
49-
* The build artifacts which have been deployed to MyGet Master Feed are tested
50-
* The release notes are reviewed, and ensured to be correct
51-
* 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
52-
* 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)
53-
* 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)
54-
* 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)
48+
* A **release **branch is created from **develop **branch
49+
* The release branch is merged into master branch, triggering a build (with deployment to MyGet Master Feed).
50+
* 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).
51+
* This set of release notes is created in draft format, ready for review, in the GitHub UI.
52+
* The build artifacts which have been deployed to MyGet Master Feed are tested
53+
* The release notes are reviewed, and ensured to be correct
54+
* 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
55+
* 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)
56+
* 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)
57+
* 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)
5558

5659
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...
5760

58-
```
61+
```text
5962
#0.12.0
6063
6164
This release included lots of bug fixes, and tonnes of new features. Enjoy!
6265
```
6366

64-
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.
67+
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/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@ GitReleaseManager is a tool that will help create a set of release notes for you
44

55
By inspecting the issues that have been assigned to a particular milestone, GitReleaseManager creates a set of release notes, in markdown format, which are then used to create a Release on GitHub.
66

7-
In addition to creating a Release, GitReleaseManager can be used to publish a release, close a milestone, and also to export the complete set of release notes for your application/product.
7+
In addition to creating a Release, GitReleaseManager can be used to publish a release, close a milestone, and also to export the complete set of release notes for your application/product.

docs/input/docs/logging/logging.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@ Order: 10
33
Title: Configure Logging
44
---
55

6-
# Configure Logging
7-
86
It is possible to view all the output from GitReleaseManager, either in the console window, or by writing out to a file.
97

108
By default, all command output is written to the console window, however, it is possible to specify a text file where command output should be written to.
@@ -13,12 +11,12 @@ By default, all command output is written to the console window, however, it is
1311

1412
Enable logging to a file located in c:\temp\log.txt using the following command:
1513

16-
```
14+
```bash
1715
gitreleasemanager.cli.exe init -l c:\temp\log.txt
1816

1917
gitreleasemanager.cli.exe init -logFilePath c:\temp\log.txt
2018
```
2119

2220
:::{.alert .alert-info}
2321
Assuming you simply wanted to **pipe** the output from GitReleaseManager to a file, when executing directly from the command line, it is not required to use the -l parameter. The log messages written to the console window, would simply be piped to the output file.
24-
:::
22+
:::

docs/input/docs/why-grm.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
22
Order: 10
3-
Title: Why use GitReleaseManager
3+
Title: Why would I want to use GitReleaseManager
44
---
55

6-
# Why would I want to use GitReleaseManager?
7-
86
There are a number of reasons that you would want to incorporate GitReleaseManager into your workflow.
97

108
:::{.alert .alert-info}
@@ -27,7 +25,7 @@ Publishing a Release also closes the associated Milestone for the Release.
2725

2826
## Add Asset to Release
2927

30-
As part of your Release process, you may want to include assets into the GitHub Release. This could be the final MSI package for your application, or a nuget package. GitReleaseManager allows you to do this in two ways. The first is using the [create command](commands/create), which includes the ability to add an asset at the time of Release creation. However, at the time of Release creation, you might not have all the assets that you want to add. As a result, there is a separate [add asset](commands/add-assets) command that you can use to add an asset to an existing Release.
28+
As part of your Release process, you may want to include assets into the GitHub Release. This could be the final MSI package for your application, or a NuGet package. GitReleaseManager allows you to do this in two ways. The first is using the [create command](commands/create), which includes the ability to add an asset at the time of Release creation. However, at the time of Release creation, you might not have all the assets that you want to add. As a result, there is a separate [add asset](commands/add-assets) command that you can use to add an asset to an existing Release.
3129

3230
## Close Milestone
3331

0 commit comments

Comments
 (0)