forked from SAP-archive/helm-broker
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.github_changelog_generator
56 lines (55 loc) · 5.4 KB
/
.github_changelog_generator
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
bugs-label=:bug: **Fixed bugs:**
issues-label=:x: **Closed issues:**
enhancement-label=:rocket: **Implemented enhancements:**
pr-label=:heavy_check_mark: **Other improvements:**
header-label=
#
# Available configuration options:
#
# - user USER Username of the owner of target GitHub repo
# - project PROJECT Name of project on GitHub
# - token [TOKEN] To make more than 50 requests per hour your GitHub token is required. You can generate it at: https://github.com/settings/tokens/new
# - date-format FORMAT Date format. Default is %Y-%m-%d
# - output [NAME] Output file. Default is CHANGELOG.md
# - base [NAME] Optional base file to append generated changes to.
# - bugs-label [LABEL] Setup custom label for bug-fixes section. Default is "**Fixed bugs:**"
# - enhancement-label [LABEL] Setup custom label for enhancements section. Default is "**Implemented enhancements:**"
# - breaking-label [LABEL] Setup custom label for the breaking changes section. Default is "**Breaking changes:**"
# - issues-label [LABEL] Setup custom label for closed-issues section. Default is "**Closed issues:**"
# - header-label [LABEL] Setup custom header label. Default is "# Change Log"
# - front-matter [JSON] Add YAML front matter. Formatted as JSON because it's easier to add on the command line
# - pr-label [LABEL] Setup custom label for pull requests section. Default is "**Merged pull requests:**"
# - issues Include closed issues in changelog. Default is true
# - issues-wo-labels Include closed issues without labels in changelog. Default is true
# - pr-wo-labels Include pull requests without labels in changelog. Default is true
# - pull-requests Include pull-requests in changelog. Default is true
# - filter-by-milestone Use milestone to detect when issue was resolved. Default is true
# - author Add author of pull-request in the end. Default is true
# - usernames-as-github-logins Use GitHub tags instead of Markdown links for the author of an issue or pull-request.
# - unreleased-only Generate log from unreleased closed issues only.
# - unreleased Add to log unreleased closed issues. Default is true
# - unreleased-label [label] Setup custom label for unreleased closed issues section. Default is "**Unreleased:**"
# - compare-link Include compare link (Full Changelog) between older version and newer version. Default is true
# - include-labels x,y,z Only issues with the specified labels will be included in the changelog.
# - exclude-labels x,y,z Issues with the specified labels will be always excluded from changelog. Default is 'duplicate,question,invalid,wontfix'
# - bug-labels x,y,z Issues with the specified labels will be always added to "Fixed bugs" section. Default is 'bug,Bug'
# - enhancement-labels x,y,z Issues with the specified labels will be always added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'
# - breaking-labels x,y,z Issues with these labels will be added to a new section, called "Breaking Changes". Default is 'backwards-incompatible'
# - issue-line-labels x,y,z The specified labels will be shown in brackets next to each matching issue. Use "ALL" to show all labels. Default is [].
# - exclude-tags x,y,z Change log will exclude specified tags
# - exclude-tags-regex [REGEX] Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*+d{1,}"
# - since-tag x Change log will start after specified tag
# - due-tag x Change log will end before specified tag
# - max-issues [NUMBER] Max number of issues to fetch from GitHub. Default is unlimited
# - release-url [URL] The URL to point to for release links, in printf format (with the tag as variable).
# - github-site [URL] The Enterprise Github site on which your project is hosted.
# - github-api [URL] The enterprise endpoint to use for your Github API.
# - simple-list Create simple list from issues and pull requests. Default is false.
# - future-release [RELEASE-VERSION] Put the unreleased changes in the specified release number.
# - release-branch [RELEASE-BRANCH] Limit pull requests to the release branch, such as master or release
# - http-cache Use HTTP Cache to cache Github API requests (useful for large repos) Default is true.
# - cache-file [CACHE-FILE] Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.
# - cache-log [CACHE-LOG] Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.
# - ssl-ca-file [PATH] Path to cacert.pem file. Default is a bundled lib/github_changelog_generator/ssl_certs/cacert.pem. Respects SSL_CA_PATH.
# - require x,y,z Path to Ruby file(s) to require.
# - verbose Run verbosely. Default is true