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/contribute/_snippets/changelog-fields.md
+4-24Lines changed: 4 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,17 +9,7 @@ title:
9
9
type:
10
10
11
11
# A required string that contains the type of change.
12
-
# It can be one of:
13
-
# - feature: new functionality
14
-
# - enhancement: extends functionality but does not break or fix existing behavior
15
-
# - bug-fix: fixes a problem in a previous version
16
-
# - known-issue: problems that we are aware of in a given version
17
-
# - breaking-change: a change to previously-documented behavior
18
-
# - deprecation: functionality that is being removed in a later release
19
-
# - docs: major documentation updates or reorgs
20
-
# - regression: functionality that no longer works or behaves incorrectly
21
-
# - security: an advisory about potential security vulnerabilities
22
-
# - other: does not fit into any of the other categories
12
+
# Refer to https://github.com/elastic/docs-builder/blob/main/src/services/Elastic.Documentation.Services/Changelog/ChangelogConfiguration.cs for the acceptable values.
23
13
24
14
products:
25
15
@@ -29,6 +19,7 @@ products:
29
19
30
20
# A required string with a predefined product ID used for release note routing,
31
21
# filters, and categorization.
22
+
# Refer to https://github.com/elastic/docs-builder/blob/main/config/products.yml for the acceptable values.
32
23
33
24
target:
34
25
@@ -40,10 +31,7 @@ products:
40
31
lifecycle:
41
32
42
33
# An optional string for new features and enhancements that have a specific availability.
43
-
# It can be one of the following:
44
-
# - preview
45
-
# - beta
46
-
# - ga
34
+
# Refer to https://github.com/elastic/docs-builder/blob/main/src/services/Elastic.Documentation.Services/Changelog/ChangelogConfiguration.cs for the acceptable values.
47
35
48
36
##### Optional fields #####
49
37
action:
@@ -91,13 +79,5 @@ pr:
91
79
subtype:
92
80
93
81
# An optional string that applies only to breaking changes and further subdivides that type.
94
-
# It can be one of:
95
-
# - api: refers to changes that break an api
96
-
# - behavioral: refers to changes the way something works
97
-
# - configuration: refers to changes that break the configuration
98
-
# - dependency: refers to changes like removing support for third-party products
99
-
# - subscription: refers to changes that break licensing behavior
100
-
# - plugin: refers to changes that break a plugin
101
-
# - security: refers to changes that break authentication, authorization, or permissions
102
-
# - other: does not fit into any of the other categories
82
+
# Refer to https://github.com/elastic/docs-builder/blob/main/src/services/Elastic.Documentation.Services/Changelog/ChangelogConfiguration.cs for the acceptable values.
0 commit comments