-
Notifications
You must be signed in to change notification settings - Fork 9
/
sample-changelog.toml
156 lines (131 loc) · 5.26 KB
/
sample-changelog.toml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
## ----------------------------------------------------------------
## sample-config
##
## All settings are listed. Non-required options are commented out
## with their default value. Required options are not commented out
## and have placeholder values.
##
## The file is in TOML-format. See the spec at
## https://github.com/toml-lang/toml
## if you have questions about its syntax.
##
## ----------------------------------------------------------------
## Path to file where the change log is written
#output = "CHANGELOG.md"
## Changes added after the last tag will be listed under this header
#nextheader = "Unreleased"
## Categories to use. 'Misc' is always included for PRs with no category.
## Note that sub projects get their own category based on their 'name'.
##
## Example: ["Kernel", "Cypher"]
## Example: ["Breaking Changes", "Enhancements", "Bug Fixes"]
#categories = ["Bug fixes", "Enhancements"]
## Settings related to git go in this section
#[git]
## Local clone of remote repo (recommend to do `git fetch <UPSTREAM>` first)
#dir = "./"
## Git SHA/tag which will mark the start of the change log. Not
## required but highly recommended. You can get a sensible value by
## doing:
##
##`git log branch1..branch2 --oneline | tail -n 1`
##
## That will give you the first commit of branch2, which means you can
## then simply specify "to=upstream/branch2" or something, and
## generate a change log for the entire branch2 history.
##
## Default value is is the project root commit.
#from = ""
## Git SHA/tag/branch/name which will mark the end of the change log.
## If you don't have a specific SHA or version number in mind, you can
## specify something like origin/branch to consider everything up to
## latest known change. (Remember to do `git fetch origin` first.)
#to = "HEAD"
## Only consider tags with the following regex-pattern (java-style, so
## remember your backslashes). A [semantic
## version](http://semver.org/) must be available in the first match
## group (first parenthesis). Default is to assume entire tag name is
## a version.
##
## Example v-prefixed versions: v(.+)
## Example only want the 3.1 versions: (3\\.1\\..+)
#tag_pattern = "(.+)"
## You can specify commits to be included in the change log in this
## file. Please see `sample-commits.toml` for syntax.
#commits_file = ""
## Settings related to github go in this section
#[github]
## It is highly recommended to specify a github token for talking to
## the Github API with. Otherwise you will be subject to heavy
## throttling, daily limits, etc. You can get generate one at
## https://github.com/settings/tokens.
#token = ""
## Set this to true if you want PR authors to be listed in the change
## log.
#include_author = false
## Combined to form the url where pull requests are fetched from
#user = ""
#repo = ""
## Settings related to github labels go in this section
#[github.labels]
## A prefix given here is used to exclude PRs which list version(s),
## and none of those versions have this prefix. For example, if a PR
## is tagged with "2.3" and "3.0", and this config gives "3.1" as its
## version prefix, then that PR is not listed in the change log. By
## default (empty string) PR version tags are ignored.
#version_prefix = ""
## Only PRs with this GH-label will be downloaded and considered for
## inclusion in the change log. You can specify multiple labels as
## well, example: "changelog,kernel" in which case ALL labels must be
## included.
#required = ""
## Only PRs which have at least one GH-label in this list will be
## included in the change log.
#include = []
## Only PRs which have no GH-labels in this list will be included in
## the change log.
#exclude = ["question", "duplicate", "invalid", "wontfix"]
## Set this to true to completely ignore PRs with no label information
## attached.
#exclude_unlabeled = false
## This section can be used to define custom mappings from GH-labels
## to better categories in the change log.
#[github.labels.category_map]
#bug = "Bug fixes"
#enhancement = "Enhancements"
## Sub projects should be defined under [subprojects.<NAME>]
#[subprojects.cyphershell]
## Used as the category in the change log
#name = "Cypher Shell"
## Just like main git settings, a sub project requires git settings to
## go under a git-section
#[subprojects.cyphershell.git]
## For sub projects, the first match group is expected to match a tag
## in the main project. A sensible organization is to prefix tags in
## your sub project as to not conflict with normal versioning:
##
## Example: neo4j-(3\\.1\\..+)
#tag_pattern = "(.+)"
## Local clone of remote repo (recommend to do `git fetch <UPSTREAM>` first)
## Required for sub projects
#dir = "~/path/to/cypher-shell"
## Git SHA/tag which will mark the start of the change log Not required
## but highly recommended.
#from = ""
## Git SHA/tag/branch/name which will mark the end of the change log.
#to = "HEAD"
## File specifying possible commits to include in log. See
## `sample-commits.toml`.
#commits_file = ""
## Just like main github settings, a subproject requires github
## settings to go under a github-section
#[subprojects.cyphershell.github]
## Combined to form the url where pull requests are fetched from
#user = ""
#repo = ""
#[subprojects.cyphershell.github.labels]
#version_prefix = ""
#required = ""
#exclude_unlabeled = false
#include = []
#exclude = []