Skip to content

Commit 0e89a54

Browse files
ruivieiraruivieira
authored
Add Git changelog automation (#136)
Automation provided by https://github.com/orhun/git-cliff
1 parent 29df789 commit 0e89a54

File tree

2 files changed

+330
-0
lines changed

2 files changed

+330
-0
lines changed

‎CHANGELOG.md

Lines changed: 259 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,259 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [unreleased]
6+
7+
8+
### [FAI-825](https://issues.redhat.com/browse/FAI-825)
9+
10+
11+
- Add feature and output name specification to models ([#130](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/130))
12+
13+
14+
### [FAI-841](https://issues.redhat.com/browse/FAI-841)
15+
16+
17+
- Python benchmarks failing since namespace migration ([#82](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/82))
18+
19+
20+
### [FAI-849](https://issues.redhat.com/browse/FAI-849)
21+
22+
23+
- Tyrus dashboard ([#97](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/97))
24+
25+
26+
### [FAI-855](https://issues.redhat.com/browse/FAI-855)
27+
28+
29+
- Move arrow converters into exp-core ([#101](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/101))
30+
31+
32+
### [FAI-863](https://issues.redhat.com/browse/FAI-863)
33+
34+
35+
- XAI-Bench ([#109](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/109))
36+
- XAIbench submodule tracking main branch, fork of xai-bench ([#111](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/111))
37+
38+
39+
### [FAI-864](https://issues.redhat.com/browse/FAI-864)
40+
41+
42+
- Fix failing RtD build after to pip migration ([#100](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/100))
43+
44+
45+
### [FAI-867](https://issues.redhat.com/browse/FAI-867)
46+
47+
48+
- Add Java 9+ Arrow compatibility flags ([#103](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/103))
49+
50+
51+
### [FAI-879](https://issues.redhat.com/browse/FAI-879)
52+
53+
54+
- Sync version with exp-core ([#107](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/107))
55+
56+
57+
### [FAI-880](https://issues.redhat.com/browse/FAI-880)
58+
59+
60+
- Move explainers into separate files ([#110](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/110))
61+
62+
63+
### [FAI-881](https://issues.redhat.com/browse/FAI-881)
64+
65+
66+
- Upgrade Pylint version ([#112](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/112))
67+
68+
69+
### [FAI-882](https://issues.redhat.com/browse/FAI-882)
70+
71+
72+
- Add kwargs to explainers ([#113](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/113))
73+
74+
75+
### [FAI-884](https://issues.redhat.com/browse/FAI-884)
76+
77+
78+
- Add SHAP background generators to bindings ([#117](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/117))
79+
80+
81+
### [FAI-886](https://issues.redhat.com/browse/FAI-886)
82+
83+
84+
- Unified input/output types, conversion functions, and docstrings ([#116](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/116))
85+
86+
87+
### [FAI-887](https://issues.redhat.com/browse/FAI-887)
88+
89+
90+
- Generalize ExplanationResults ([#115](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/115))
91+
92+
93+
### [FAI-889](https://issues.redhat.com/browse/FAI-889)
94+
95+
96+
- Allow non-string categorical feature domains ([#118](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/118))
97+
98+
99+
### [FAI-892](https://issues.redhat.com/browse/FAI-892)
100+
101+
102+
- Tyrus TempDirectory ([#121](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/121))
103+
104+
105+
### [FAI-893](https://issues.redhat.com/browse/FAI-893)
106+
107+
108+
- Make test plots non-blocking by default ([#120](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/120))
109+
110+
111+
### [FAI-896](https://issues.redhat.com/browse/FAI-896)
112+
113+
114+
- Doc standardization and cleanup ([#126](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/126))
115+
116+
117+
### [FAI-897](https://issues.redhat.com/browse/FAI-897)
118+
119+
120+
- Add bokeh dependency ([#123](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/123))
121+
122+
123+
### [FAI-900](https://issues.redhat.com/browse/FAI-900)
124+
125+
126+
- Added feature domain argument to counterfactuals ([#128](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/128))
127+
128+
129+
### [FAI-901](https://issues.redhat.com/browse/FAI-901)
130+
131+
132+
- Increased input/ouput conversion flexibility ([#127](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/127))
133+
134+
135+
### [FAI-903](https://issues.redhat.com/browse/FAI-903)
136+
137+
138+
- Add group fairness Python bindings ([#129](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/129))
139+
140+
141+
### [FAI-911](https://issues.redhat.com/browse/FAI-911)
142+
143+
144+
- Improve API to declare selections in Python fairness ([#132](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/132))
145+
146+
## [0.2.5] - 2022-09-14
147+
148+
149+
### Bug Fixes
150+
151+
152+
- Fixed linting, adding doc build reqs to requirements-dev
153+
154+
- Fixed line-too-long linting errors
155+
156+
- Fixed distutils import formatting
157+
158+
- Fixed conflicts with FAI-806, added build output
159+
160+
- Fixed incorrect LIME typing
161+
162+
- Fixed typo in Output field
163+
164+
- Fixed rtd.yaml python version inconsistency
165+
166+
- Fixed path in rtd install config
167+
168+
- Fixed custom.css path
169+
170+
- Fixed failing tests
171+
172+
- Fixed black-induced line-too-long
173+
174+
- Fixed failing shapresults.getSaliencies call
175+
176+
- Fixed linting errors re. import order
177+
178+
- Fixed failing initializer tests
179+
180+
- Fixed unrelated explainers change
181+
182+
- Fixed incorrect ShapResults.get_saliency output type
183+
184+
- Fixed broken favicon
185+
186+
- Fixed linting issue
187+
188+
- Fixed enumeration tuple issue
189+
190+
- Fixed failing SHAP tests, improved output name imputation in Model
191+
192+
- Fixed overzealous find and replace of trustyai
193+
194+
- Fixed overzealous find and replace of trustyai part 2
195+
196+
- Fixed broken output casting for 1d output arrays
197+
198+
199+
200+
### [FAI-797b](https://issues.redhat.com/browse/FAI-797b)
201+
202+
203+
- Include doc link in README
204+
205+
## [0.2.4] - 2022-06-16
206+
207+
## [0.2.3] - 2022-05-12
208+
209+
210+
### Bug Fixes
211+
212+
213+
- Fixed missing final newline
214+
215+
216+
## [0.2.2] - 2022-04-25
217+
218+
## [0.2.1] - 2022-04-22
219+
220+
## [0.2.0] - 2022-04-22
221+
222+
223+
### Bug Fixes
224+
225+
226+
- Fixed linting issues
227+
228+
- Fixed linting issues re. the glob checker for wildcard paths
229+
230+
- Fixed line-too-long linting issue in model/__init__
231+
232+
233+
234+
### Refactor
235+
236+
237+
- Refactored arrow inclusion; mvn pulls dependencies, then includes precompiled arrowconverters jar
238+
239+
240+
## [0.1.1] - 2022-03-09
241+
242+
## [0.0.9] - 2022-02-17
243+
244+
## [0.0.8] - 2022-02-17
245+
246+
## [0.0.7] - 2022-02-17
247+
248+
## [0.0.6] - 2022-02-17
249+
250+
## [0.0.5] - 2022-01-22
251+
252+
## [0.0.4] - 2022-01-22
253+
254+
## [0.0.3] - 2021-11-04
255+
256+
## [0.0.2] - 2021-08-09
257+
258+
## [0.0.1] - 2021-07-21
259+

‎cliff.toml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# configuration file for git-cliff (0.1.0)
2+
3+
[changelog]
4+
# changelog header
5+
header = """
6+
# Changelog\n
7+
All notable changes to this project will be documented in this file.\n
8+
"""
9+
# template for the changelog body
10+
# https://tera.netlify.app/docs/#introduction
11+
body = """
12+
{% if version %}\
13+
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
14+
{% else %}\
15+
## [unreleased]
16+
{% endif %}\
17+
{% for group, commits in commits | group_by(attribute="group") %}
18+
{% if group is starting_with("FAI-") %}
19+
{% set issue_id = group | trim_start_matches(pat="FAI-") -%}
20+
### [FAI-{{ issue_id }}](https://issues.redhat.com/browse/FAI-{{ issue_id }})
21+
{% else %}
22+
### {{ group | upper_first }}
23+
{% endif %}
24+
{% for commit in commits %}
25+
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\
26+
{% endfor %}
27+
{% endfor %}\n
28+
"""
29+
# remove the leading and trailing whitespace from the template
30+
trim = true
31+
# changelog footer
32+
footer = ""
33+
34+
[git]
35+
# parse the commits based on https://www.conventionalcommits.org
36+
conventional_commits = true
37+
# filter out the commits that are not conventional
38+
filter_unconventional = false
39+
# process each line of a commit as an individual commit
40+
split_commits = false
41+
# regex for preprocessing the commit messages
42+
commit_preprocessors = [
43+
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/trustyai-explainability/trustyai-explainability-python/pull/${2}))"},
44+
{ pattern = 'FAI-([0-9]+)\s', replace = "[FAI-${1}](https://issues.redhat.com/browse/FAI-${1})"},
45+
# { pattern = 'FAI-([0-9]+)\s', replace = "[FAI-${1}](https://issues.redhat.com/browse/FAI-${1})"},
46+
]
47+
# regex for parsing and grouping commits
48+
commit_parsers = [
49+
{ message = "^feat", group = "Features"},
50+
{ message = "^fix", group = "Bug Fixes"},
51+
{ message = "^doc", group = "Documentation"},
52+
{ message = "^perf", group = "Performance"},
53+
{ message = "^refactor", group = "Refactor"},
54+
{ message = "^style", group = "Styling"},
55+
{ message = "^test", group = "Testing"},
56+
{ message = "^chore\\(release\\): prepare for", skip = true},
57+
{ message = "^chore", group = "Miscellaneous Tasks"},
58+
{ body = ".*security", group = "Security"},
59+
]
60+
# filter out the commits that are not matched by commit parsers
61+
filter_commits = false
62+
# glob pattern for matching git tags
63+
tag_pattern = "[0-9]*"
64+
# regex for skipping tags
65+
skip_tags = "v0.1.0-beta.1"
66+
# regex for ignoring tags
67+
ignore_tags = ""
68+
# sort the tags chronologically
69+
date_order = false
70+
# sort the commits inside sections by oldest/newest order
71+
sort_commits = "oldest"

0 commit comments

Comments
 (0)