1# Changelog
2
3All notable changes to this project will be documented in this file.
4
5The format is based on [Keep a Changelog](http://keepachangelog.com/)
6and this project adheres to [Semantic Versioning](http://semver.org/).
7
8<!-- Format restrictions - see https://common-changelog.org and https://keepachangelog.com/ for details -->
9<!-- Each Release must start with a line for the release version of exactly this format: ## [version] -->
10<!-- The subsequent comment lines start with a space - not to irritate the release scripts parser!
11 ## [yyyy-mm-dd]
12 <empty line> - optional sub sections may follow like:
13 ### Added:
14 - This feature was added
15 <empty line>
16 ### Changed:
17 - This feature was changed
18 <empty line>
19 ### Removed:
20 - This feature was removed
21 <empty line>
22 ### Fixed:
23 - This issue was fixed
24 <empty line>
25 <empty line> - next line is the starting of the previous release
26 ## [yyyy-mm-dd]
27 <empty line>
28 <...>
29 !!! In addition the compare URL links are to be maintained at the end of this CHANGELOG.md as follows.
30     These links provide direct access to the GitHub compare vs. the previous release.
31     The particular link of a released version will be copied to the release notes of a release accordingly.
32     At the end of this file appropriate compare links have to be maintained for each release version in format:
33
34  +-current release version
35  |
36  |            +-URL to this repo               previous release version tag-+            +-current release version tag
37  |            |                                                             |            |
38 [yyyy-mm-dd]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/vYYYY-MM-DD..vYYYY-MM-DD
39-->
40<!--
41## [Unreleased]
42
43### Added
44- TBD
45
46### Changed
47- TBD
48
49### Deprecated
50- TBD
51
52###	Removed
53- TBD
54
55### Fixed
56- TBD
57
58###	Security
59- TBD
60-->
61
62## [Unreleased]
63
64### Changed
65- TBD
66
67
68## [2023-05-07]
69
70### Fixed
71- Deprecation warnings raised on `action/editcommit.php` - fixes [#86]
72
73
74## [2023-03-07]
75
76### Changed
77- Allow absolute path in `'repoPath'` and/or `'repoWorkDir'` - implements [#80]
78- `'repoWorkDir'` is configured empty by default now
79- `--work-tree` option is ommited, if `'repoWorkDir'` is empty - addressing [#79]
80
81### Fixed
82- Cyrillic commit messages not being corrupted anymore - fixes [#82]
83
84
85## [2022-02-06]
86
87### Changed
88- Created LICENSE file and removed corresponding text from the README.md - implements [#67]
89- Use DokuWiki's user name & email address as commit author - implements [#63], [#66]
90  - Updated default setting for `$conf['addParams']` to apply DokuWiki user name as commit author and DokuWiki user eMail as eMail.
91  - If DokuWiki user eMail is empty, then the eMail assigned to the commit will be empty as well.
92- Updated README.md:
93  - Added a link to the referred COPYING license file originally hosted on the DokuWiki master branch to simplify a probable lookup.
94  - Issues linked on startpage, motivate people to contribute
95
96### Fixed
97- Allow empty commits - fixes [#39]
98
99
100## [2022-01-20]
101
102### Fixed
103- Fix for compatibility to PHP versions <7.4 - was introduced by previous release - fixes [#69]
104
105
106## [2021-03-19]
107
108### Added
109- Extended to send error messages to a configurable eMail address - implements [#53]
110- Added config `'emailAddressOnError'`
111- Added config `'notifyByMailOnSuccess'`
112- Added localizations for error messages
113- Added eMail templates for mail notifications
114- German translations added
115
116
117## [2016-08-14]
118
119### Changed
120- Updated last change date to current date - fix [#38]
121
122### Fixed
123- Adjusted method signatures to match parent in action/editcommit.php
124- Corrected method signature for php7-compatibility in action/editcommit.php
125
126
127## [2015-10-03]
128
129### Added
130- Allow name and mail user variables in addParams.
131- Add an option for customizing git working tree
132- Added setting ignorePaths to ignore specified paths in add/commit-process
133
134### Changed
135- Use Markdown for the GitHub README.
136- Update plugin date and URL, added Carsten Teibes as author
137- Pull latest git php library (0.1.4)
138- Allow to set the path to the git binary - implements [#8]
139- Use relative path for Git.php and `$conf['tempdir']` for temp file.
140- Coding compliance change: move handle_periodic_pull down, together with other "handle"s.
141
142### Fixed
143- Fix passing additional arguments to git binary
144- Fix lang typos.
145- Coding compliance change, tabs to spaces, fix typos.
146- dokuwiki Farm fix
147
148
149## [2012-10-31]
150
151### Added
152- Initial release
153
154### Comments
155- The release name complies with the date property of plugin.info.txt
156- The recent commit within this release is [2dbc1a5](https://github.com/woolfg/dokuwiki-plugin-gitbacked/commit/2dbc1a5564516b801dbda239b68152edb5be0303) of 13-Nov-2012
157
158<!--
159## []
160
161### NeverReleased
162- This is just a dummy placeholder to make the parser of GHCICD/release-notes-from-changelog@v1 happy!
163-->
164
165[Unreleased]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2023-05-07..HEAD
166[2023-05-07]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2023-03-07..v2023-05-07
167[2023-03-07]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2022-02-06..v2023-03-07
168[2022-02-06]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2022-01-20..v2022-02-06
169[2022-01-20]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2021-03-19..v2022-01-20
170[2021-03-19]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2016-08-14..v2021-03-19
171[2016-08-14]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2015-10-03..v2016-08-14
172[2015-10-03]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2012-10-31..v2015-10-03
173[2012-10-31]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/releases/tag/v2012-10-31
174[#86]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/86
175[#82]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/82
176[#80]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/80
177[#79]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/79
178[#69]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/69
179[#67]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/67
180[#66]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/66
181[#63]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/63
182[#53]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/53
183[#39]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/39
184[#38]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/38
185[#8]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/8
186