You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/configuration/create-configuration.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ This would result in the following [release notes](https://github.com/chocolatey
22
22
<divclass="admonition note">
23
23
<p class="first admonition-title">Note</p>
24
24
<p class="last">
25
-
The generated URL for the link to Chocolatey.org includes the milestone number. The complete URL is https://chocolatey.org/packages/chocolateyGUI/0.13.1. This was achieved by using a regular expression replacement of the [footer-content](doc:default-configuration), using the [milestone-replace-text](doc:default-configuration) property as the text to replace with the actual milestone.
25
+
The generated URL for the link to Chocolatey.org includes the milestone number. The complete URL is https://chocolatey.org/packages/chocolateyGUI/0.13.1. This was achieved by using a regular expression replacement of the [footer-content](default-configuration.md), using the [milestone-replace-text](default-configuration.md) property as the text to replace with the actual milestone.
26
26
27
27
This approach can be used for any project, this example simply shows what is done in the ChocolateyGUI project.
Copy file name to clipboardExpand all lines: docs/configuration/default-configuration.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,7 @@ When creating a Release, there are a number of options which can be set to contr
48
48
***milestone-replace-text**
49
49
* A string value which contains the string which should be replaced in the footer-content with the actual milestone release number. Default is an empty string.
50
50
51
-
See the [example create configuration section](doc:create-configuration) to see an example of how a footer can be configured.
51
+
See the [example create configuration section](create-configuration.md) to see an example of how a footer can be configured.
52
52
53
53
## Export Options
54
54
@@ -63,10 +63,10 @@ See the [example create configuration section](doc:create-configuration) to see
63
63
***multiline-regex**
64
64
* A boolean value which indicates that the regular expression should span multiple lines. Default is false.
65
65
66
-
See the [example export configuration section](doc:export-configuration) to see an example of how the export can be configured.
66
+
See the [example export configuration section](export-configuration.md) to see an example of how the export can be configured.
67
67
68
68
## Issues to include
69
-
See the [Issues to include](doc:issues-to-include) section.
69
+
See the [Issues to include](include-issues.md) section.
70
70
71
71
## Issues to exclude
72
-
See the [Issues to exclude](doc:issues-to-exclude) section.
72
+
See the [Issues to exclude](exclude-issues.md) section.
Copy file name to clipboardExpand all lines: docs/why-grm.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Why would I want to use GitReleaseManager?
2
2
3
-
There are a number of reasons that you would want to incorporate GitReleaseManager into your workflow.
3
+
There are a number of reasons that you would want to incorporate GitReleaseManager into your workflow.
4
4
5
5
<divclass="admonition note">
6
6
<p class="first admonition-title">Note</p>
@@ -13,11 +13,11 @@ Here are a few examples:
13
13
14
14
## Create Milestone Release Notes
15
15
16
-
Assuming that you are already using the concept of milestones in GitHub, once a milestone is completed, and you have a number of closed issues, you can use the [create command](doc:create) to generate a draft set of release notes, which includes all the closed issues (assuming that they match the [set of labels](doc:issues-to-include) which are configured to be included.
16
+
Assuming that you are already using the concept of milestones in GitHub, once a milestone is completed, and you have a number of closed issues, you can use the [create command](commands/create.md) to generate a draft set of release notes, which includes all the closed issues (assuming that they match the [set of labels](configuration/include-issues.md) which are configured to be included.
17
17
18
18
## Publish Release
19
19
20
-
Even if you don't want to use GitReleaseManager to create the release notes on GitHub, you may still want the ability to Publish a Release (which has the result of creating a tag in your repository). This can be done using the [publish command](doc:publish).
20
+
Even if you don't want to use GitReleaseManager to create the release notes on GitHub, you may still want the ability to Publish a Release (which has the result of creating a tag in your repository). This can be done using the [publish command](commands/publish.md).
21
21
22
22
<divclass="admonition note">
23
23
<p class="first admonition-title">Note</p>
@@ -28,12 +28,12 @@ Even if you don't want to use GitReleaseManager to create the release notes on G
28
28
29
29
## Add Asset to Release
30
30
31
-
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](doc: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](doc:add-asset) command that you can use to add an asset to an existing Release.
31
+
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.md), 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.md) command that you can use to add an asset to an existing Release.
32
32
33
33
## Close Milestone
34
34
35
-
When working directly in GitHub, publishing a Release doesn't close the associated milestone. When using the GitReleaseManager's [publish command](doc:publish) the associated milestone is also closed. However, you can also use the [close command](doc:close] directly if you are not using the publish workflow as part of your process.
35
+
When working directly in GitHub, publishing a Release doesn't close the associated milestone. When using the GitReleaseManager's [publish command](commands/publish.md) the associated milestone is also closed. However, you can also use the [close command](commands/doc:close] directly if you are not using the publish workflow as part of your process.
36
36
37
37
## Export Release Notes
38
38
39
-
When working on a project, you might want to include all the Release Notes within the application itself, let's say in the About dialog. GitReleaseManager's [export command](doc:export) makes it really simple to export the entire history of your application/product, by creating a markdown file with all the information contained in the releases section of GitHub.
39
+
When working on a project, you might want to include all the Release Notes within the application itself, let's say in the About dialog. GitReleaseManager's [export command](commands/export.md) makes it really simple to export the entire history of your application/product, by creating a markdown file with all the information contained in the releases section of GitHub.
0 commit comments