@@ -13,25 +13,42 @@ when no yaml file is placed in the root directory):
13
13
``` yaml
14
14
create :
15
15
include-footer : false
16
- footer-heading :
17
- footer-content :
16
+ footer-heading : ' '
17
+ footer-content : ' '
18
18
footer-includes-milestone : false
19
- milestone-replace-text :
19
+ milestone-replace-text : ' '
20
20
include-sha-section : false
21
21
sha-section-heading : " SHA256 Hashes of the release artifacts"
22
22
sha-section-line-format : " - `{1}\t {0}`"
23
23
export :
24
24
include-created-date-in-title : false
25
- created-date-string-format :
25
+ created-date-string-format : ' '
26
26
perform-regex-removal : false
27
- regex-text :
27
+ regex-text : ' '
28
28
multiline-regex : false
29
+ close :
30
+ use-issue-comments : false
31
+ issue-comment : |-
32
+ :tada: This issue has been resolved in version {milestone} :tada:
33
+
34
+ The release is available on:
35
+
36
+ - [GitHub release](https://github.com/{owner}/{repository}/releases/tag/{milestone})
37
+
38
+ Your **[GitReleaseManager](https://github.com/GitTools/GitReleaseManager)** bot :package::rocket:
29
39
issue-labels-include :
30
40
- Bug
41
+ - Duplicate
42
+ - Enhancement
31
43
- Feature
44
+ - Help Wanted
32
45
- Improvement
46
+ - Invalid
47
+ - Question
48
+ - Wontfix
33
49
issue-labels-exclude :
34
50
- Internal Refactoring
51
+ issue-labels-alias : []
35
52
` ` `
36
53
37
54
Essentially, the only settings that are enabled by default are those that
@@ -114,10 +131,32 @@ example of how a footer can be configured.
114
131
See the [example export configuration section](export-configuration) to see an
115
132
example of how the export can be configured.
116
133
134
+ # # Close Options
135
+
136
+ When it comes to closing a milestone with GitReleaseManager, it is possible to
137
+ add a comment to any closed issues that were included within that milestone.
138
+ This is useful to inform any users who are subscribed to an issue, that this
139
+ feature or bug, has actually been shipped. It is possible to completely control
140
+ the content of the issue comment that is added, as well as replace some
141
+ tokenized values, such as milestone, owner, repository, with the actual values.
142
+
143
+ - **use-issue-comments**
144
+ - A boolean value which indicates whether or not comments are added to any
145
+ closed issues that are included within a milestone, when it is being
146
+ closed.
147
+ - **issue-comment**
148
+ - This is a template for what comment should be added to each issue. Within
149
+ this comment template, it is possible to replace information for example,
150
+ the milestone name, the owner/repository information, etc.
151
+
117
152
# # Issues to include
118
153
119
154
See the [Issues to include](include-issues) section.
120
155
121
156
# # Issues to exclude
122
157
123
158
See the [Issues to exclude](exclude-issues) section.
159
+
160
+ # # Issue Labels Alias
161
+
162
+ See the [Issue Label Alias](label-aliases) section.
0 commit comments