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/input/docs/configuration/default-configuration.md
+23-20Lines changed: 23 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,9 @@ create:
14
14
footer-content:
15
15
footer-includes-milestone: false
16
16
milestone-replace-text:
17
+
include-sha-section: false
18
+
sha-section-heading: "SHA256 Hashes of the release artifacts"
19
+
sha-section-line-format: "- `{1}\t{0}`"
17
20
export:
18
21
include-created-date-in-title: false
19
22
created-date-string-format:
@@ -38,31 +41,31 @@ Not all options are required. For example, footer-content, is an empty string b
38
41
39
42
When creating a Release, there are a number of options which can be set to control the look and feel of the generated release notes.
40
43
41
-
* **include-footer**
42
-
* A boolean value which indicates that a footer should be included within the release notes. Default is false.
43
-
* **footer-heading**
44
-
* A string value which contains the heading text for the footer. Default is an empty string.
45
-
* **footer-content**
46
-
* A string value which contains the main body text for the footer. This can be anything. A typical example might be to provide information about where the release can be installed from. Default is an empty string.
47
-
* **footer-includes-milestone**
48
-
* A boolean value which indicates that the footer content contains a milestone, which should be replaced with the actual milestone value. As an example, let's say you want to provide a link to where you can download your release, and the URL could be something like http://mydomain.com/releases/0.1.0. You don't want to have to hard code the milestone number into your yaml configuration, so instead, you can use a replacement string in your footer-content, which will then be replaced with the actual milestone release number, when the release is created. Default is false.
49
-
* **milestone-replace-text**
50
-
* 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.
44
+
* **include-footer**
45
+
* A boolean value which indicates that a footer should be included within the release notes. Default is false.
46
+
* **footer-heading**
47
+
* A string value which contains the heading text for the footer. Default is an empty string.
48
+
* **footer-content**
49
+
* A string value which contains the main body text for the footer. This can be anything. A typical example might be to provide information about where the release can be installed from. Default is an empty string.
50
+
* **footer-includes-milestone**
51
+
* A boolean value which indicates that the footer content contains a milestone, which should be replaced with the actual milestone value. As an example, let's say you want to provide a link to where you can download your release, and the URL could be something like http://mydomain.com/releases/0.1.0. You don't want to have to hard code the milestone number into your yaml configuration, so instead, you can use a replacement string in your footer-content, which will then be replaced with the actual milestone release number, when the release is created. Default is false.
52
+
* **milestone-replace-text**
53
+
* 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.
51
54
52
55
See the [example create configuration section](create-configuration) to see an example of how a footer can be configured.
53
56
54
57
## Export Options
55
58
56
-
* **include-created-date-in-title**
57
-
* A boolean value which indicates whether the date of which a Release occurred should be included within the heading section of generated release notes. Default is false.
58
-
* **created-date-string-format**
59
-
* A string value which contains the Date Time Format string which should be used when including the created date in the title of the release notes. Default is an empty string.
60
-
* **perform-regex-removal**
61
-
* A boolean value which inidcates whether a regular expression should be performed on the generated release notes to remove some text. Default is false.
62
-
* **regex-text**
63
-
* A string value which contains the regular expression to match against the generated release notes, in order to remove text. Default in an empty string.
64
-
* **multiline-regex**
65
-
* A boolean value which indicates that the regular expression should span multiple lines. Default is false.
59
+
* **include-created-date-in-title**
60
+
* A boolean value which indicates whether the date of which a Release occurred should be included within the heading section of generated release notes. Default is false.
61
+
* **created-date-string-format**
62
+
* A string value which contains the Date Time Format string which should be used when including the created date in the title of the release notes. Default is an empty string.
63
+
* **perform-regex-removal**
64
+
* A boolean value which inidcates whether a regular expression should be performed on the generated release notes to remove some text. Default is false.
65
+
* **regex-text**
66
+
* A string value which contains the regular expression to match against the generated release notes, in order to remove text. Default in an empty string.
67
+
* **multiline-regex**
68
+
* A boolean value which indicates that the regular expression should span multiple lines. Default is false.
66
69
67
70
See the [example export configuration section](export-configuration) to see an example of how the export can be configured.
0 commit comments