Skip to content

Commit 5715600

Browse files
committed
Add config for changelog generator.
1 parent 5214c52 commit 5715600

File tree

1 file changed

+109
-0
lines changed

1 file changed

+109
-0
lines changed

.github_changelog_generator

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# ==============================================================================
2+
# Project Specific
3+
# ------------------------------------------------------------------------------
4+
user=pdsinterop
5+
project=php-solid-server
6+
# ------------------------------------------------------------------------------
7+
breaking-labels=backwards-incompatible, Backwards incompatible, breaking
8+
bug-labels=bug
9+
deprecated-labels=deprecated, Deprecated, Type: Deprecated
10+
enhancement-labels=improvement, documentation, enhancement
11+
exclude-labels=question, duplicate,invalid
12+
removed-labels=removed, Removed, Type: Removed
13+
security-labels=security, Security, Type: Security
14+
summary-labels=Release summary, release-summary, Summary, summary
15+
unreleased-label=Unreleased
16+
# ==============================================================================
17+
18+
# ==============================================================================
19+
# Organisation-wide
20+
# ------------------------------------------------------------------------------
21+
# Output and content related
22+
# ------------------------------------------------------------------------------
23+
date-format=%Y-%m-%d
24+
output=CHANGELOG.md
25+
header=# Changelog
26+
breaking-prefix=### Breaking changes
27+
bug-prefix=### Fixes
28+
deprecated-prefix=### Deprecates
29+
enhancement-prefix=### Changes
30+
issue-prefix=### Closes
31+
merge-prefix=### Pull request(s) without label
32+
removed-prefix=### Removes
33+
security-prefix=### Security
34+
# ------------------------------------------------------------------------------
35+
add-issues-wo-labels=true
36+
add-pr-wo-labels=true
37+
author=true
38+
compare-link=true
39+
filter-issues-by-milestone=true
40+
# http-cache=true
41+
issues=true
42+
pulls=true
43+
# unreleased-only=true
44+
unreleased=true
45+
usernames-as-github-logins=true
46+
verbose=false
47+
# ==============================================================================
48+
49+
;user USER Username of the owner of the target GitHub repo OR the namespace of target Github repo if owned by an organization.
50+
;project PROJECT Name of project on GitHub.
51+
;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
52+
;date-format FORMAT Date format. Default is %Y-%m-%d.
53+
;output NAME Output file. To print to STDOUT instead, use blank as path. Default is CHANGELOG.md
54+
;base NAME Optional base file to append generated changes to. Default is HISTORY.md
55+
;summary-label LABEL Set up custom label for the release summary section. Default is "".
56+
;breaking-label LABEL Set up custom label for the breaking changes section. Default is "**Breaking changes:**".
57+
;enhancement-label LABEL Set up custom label for enhancements section. Default is "**Implemented enhancements:**".
58+
;bugs-label LABEL Set up custom label for bug-fixes section. Default is "**Fixed bugs:**".
59+
;deprecated-label LABEL Set up custom label for the deprecated changes section. Default is "**Deprecated:**".
60+
;removed-label LABEL Set up custom label for the removed changes section. Default is "**Removed:**".
61+
;security-label LABEL Set up custom label for the security changes section. Default is "**Security fixes:**".
62+
;issues-label LABEL Set up custom label for closed-issues section. Default is "**Closed issues:**".
63+
;header-label LABEL Set up custom header label. Default is "# Changelog".
64+
;configure-sections STRING Define your own set of sections which overrides all default sections.
65+
;add-sections HASH, STRING Add new sections but keep the default sections.
66+
;front-matter JSON Add YAML front matter. Formatted as JSON because it's easier to add on the command line.
67+
;pr-label LABEL Set up custom label for pull requests section. Default is "**Merged pull requests:**".
68+
;issues Include closed issues in changelog. Default is true.
69+
;issues-wo-labels Include closed issues without labels in changelog. Default is true.
70+
;pr-wo-labels Include pull requests without labels in changelog. Default is true.
71+
;pull-requests Include pull-requests in changelog. Default is true.
72+
;filter-by-milestone Use milestone to detect when issue was resolved. Default is true.
73+
;issues-of-open-milestones Include issues of open milestones. Default is true.
74+
;author Add author of pull request at the end. Default is true.
75+
;usernames-as-github-logins Use GitHub tags instead of Markdown links for the author of an issue or pull-request.
76+
;unreleased-only Generate log from unreleased closed issues only.
77+
;unreleased Add to log unreleased closed issues. Default is true.
78+
;unreleased-label LABEL Set up custom label for unreleased closed issues section. Default is "**Unreleased:**".
79+
;compare-link Include compare link (Full Changelog) between older version and newer version. Default is true.
80+
;include-labels x,y,z Of the labeled issues, only include the ones with the specified labels.
81+
;exclude-labels x,y,z Issues with the specified labels will be excluded from changelog. Default is 'duplicate,question,invalid,wontfix'.
82+
;summary-labels x,y,z Issues with these labels will be added to a new section, called "Release Summary". The section display only body of issues. Default is 'release-summary,summary'.
83+
;breaking-labels x,y,z Issues with these labels will be added to a new section, called "Breaking changes". Default is 'backwards-incompatible,breaking'.
84+
;enhancement-labels x,y,z Issues with the specified labels will be added to "Implemented enhancements" section. Default is 'enhancement,Enhancement'.
85+
;bug-labels x,y,z Issues with the specified labels will be added to "Fixed bugs" section. Default is 'bug,Bug'.
86+
;deprecated-labels x,y,z Issues with the specified labels will be added to a section called "Deprecated". Default is 'deprecated,Deprecated'.
87+
;removed-labels x,y,z Issues with the specified labels will be added to a section called "Removed". Default is 'removed,Removed'.
88+
;security-labels x,y,z Issues with the specified labels will be added to a section called "Security fixes". Default is 'security,Security'.
89+
;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 [].
90+
;include-tags-regex REGEX Apply a regular expression on tag names so that they can be included, for example: --include-tags-regex ".*+d{1,}".
91+
;exclude-tags x,y,z Changelog will exclude specified tags
92+
;exclude-tags-regex REGEX Apply a regular expression on tag names so that they can be excluded, for example: --exclude-tags-regex ".*+d{1,}".
93+
;since-tag x Changelog will start after specified tag.
94+
;due-tag x Changelog will end before specified tag.
95+
;since-commit x Fetch only commits after this time. eg. "2017-01-01 10:00:00"
96+
;max-issues NUMBER Maximum number of issues to fetch from GitHub. Default is unlimited.
97+
;release-url URL The URL to point to for release links, in printf format (with the tag as variable).
98+
;github-site URL The Enterprise GitHub site where your project is hosted.
99+
;github-api URL The enterprise endpoint to use for your GitHub API.
100+
;simple-list Create a simple list from issues and pull requests. Default is false.
101+
;future-release VERSION Put the unreleased changes in the specified release number.
102+
;release-branch BRANCH Limit pull requests to the release branch, such as master or release.
103+
;http-cache Use HTTP Cache to cache GitHub API requests (useful for large repos). Default is true.
104+
;cache-file CACHE-FILE Filename to use for cache. Default is github-changelog-http-cache in a temporary directory.
105+
;cache-log CACHE-LOG Filename to use for cache log. Default is github-changelog-logger.log in a temporary directory.
106+
;config-file CONFIG-FILE Path to configuration file. Default is .github_changelog_generator.
107+
;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.
108+
;require x,y,z Path to Ruby file(s) to require before generating changelog.
109+
;verbose Run verbosely. Default is true.

0 commit comments

Comments
 (0)