xref: /plugin/gitbacked/CHANGELOG.md (revision 84aa20e731d064c66e2500344a5dbb986f2b6718)
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 ### �� Breaking Change(s):
14 - This feature was changed
15 <empty line>
16 ### �� Added:
17 - This feature was added
18 <empty line>
19 ### �� Changed:
20 - This feature was changed
21 <empty line>
22 ### �� Removed:
23 - This feature was removed
24 <empty line>
25 ### �� Fixed:
26 - This issue was fixed
27 <empty line>
28 <empty line> - next line is the starting of the previous release
29 ## [yyyy-mm-dd]
30 <empty line>
31 <...>
32 !!! In addition the compare URL links are to be maintained at the end of this CHANGELOG.md as follows.
33     These links provide direct access to the GitHub compare vs. the previous release.
34     The particular link of a released version will be copied to the release notes of a release accordingly.
35     At the end of this file appropriate compare links have to be maintained for each release version in format:
36
37  +-current release version
38  |
39  |            +-URL to this repo               previous release version tag-+            +-current release version tag
40  |            |                                                             |            |
41 [yyyy-mm-dd]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/vYYYY-MM-DD..vYYYY-MM-DD
42-->
43<!--
44## [Unreleased]
45
46### �� Breaking Change
47- TBD
48
49### �� Added
50- TBD
51
52### �� Changed
53- TBD
54
55### ⚠️ Deprecated
56- TBD
57
58###	�� Removed
59- TBD
60
61### �� Fixed
62- TBD
63
64###	��️ Security
65- TBD
66
67### �� Documentation
68- TBD
69-->
70
71## [Unreleased]
72
73### �� Changed
74- TBD
75
76
77## [2026-02-21]
78
79### �� Added
80- Additional placeholders in commit message template - PR [#103]
81
82### �� Changed
83- Centralize `%user%`, `%mail%` and `\n` replacement:
84  - moved within `action/editcommit.php` to `commitFile(...)` - PR [#103]
85
86### ❤️ Thanks
87Many thanks for collaboration on this release for: @dotsam
88
89
90## [2025-11-11]
91
92### �� Added
93- Add code style config files
94- Add code style check
95- Add auto loader `loader.php`
96
97### �� Fixed
98- Fix warnings on periodic pulls as no user is logged in -  PR [#100]
99- Replace references to deprecated classes by non deprecated classes
100- Update code to meet DokuWiki standard code style
101- Make use of plugin specific namespace for `classes/*.php` classes
102
103### ❤️ Thanks
104Many thanks for collaboration on this release for: @ribsey, @mhoffrog
105
106
107## [2025-02-26]
108
109### �� Added
110- Add config `'updateIndexOnPull'` - PR [#93], [#94]
111
112### �� Changed
113- Avoid using $_ENV in `lib/Git.php#run_command` - PR [#91]
114  - ensuring more controlled and secure handling of environment variables
115  - fixes probable warning 'Array to string conversion'
116
117### ❤️ Thanks
118Many thanks for collaboration on this release for: @msx80, @delphij
119
120
121## [2023-05-07]
122
123### �� Fixed
124- Deprecation warnings raised on `action/editcommit.php` - fixes [#86]
125
126### ❤️ Thanks
127Many thanks for collaboration on this release for: @mhoffrog
128
129
130## [2023-03-07]
131
132### �� Changed
133- Allow absolute path in `'repoPath'` and/or `'repoWorkDir'` - implements [#80]
134- `'repoWorkDir'` is configured empty by default now
135- `--work-tree` option is ommited, if `'repoWorkDir'` is empty - addressing [#79]
136
137### �� Fixed
138- Cyrillic commit messages not being corrupted anymore - fixes [#82]
139
140### ❤️ Thanks
141Many thanks for collaboration on this release for: @sjv0, @zlobniyshurik
142
143
144## [2022-02-06]
145
146### �� Changed
147- Created LICENSE file and removed corresponding text from the README.md - implements [#67]
148- Use DokuWiki's user name & email address as commit author - implements [#63], [#66]
149  - Updated default setting for `$conf['addParams']` to apply DokuWiki user name as commit author and DokuWiki user eMail as eMail.
150  - If DokuWiki user eMail is empty, then the eMail assigned to the commit will be empty as well.
151- Updated README.md:
152  - Added a link to the referred COPYING license file originally hosted on the DokuWiki master branch to simplify a probable lookup.
153  - Issues linked on startpage, motivate people to contribute
154
155### �� Fixed
156- Allow empty commits - fixes [#39]
157
158### ❤️ Thanks
159Many thanks for collaboration on this release for: @SECtim, @ochurlaud
160
161
162## [2022-01-20]
163
164### �� Fixed
165- Fix for compatibility to PHP versions <7.4 - was introduced by previous release - fixes [#69]
166
167
168## [2021-03-19]
169
170### �� Added
171- Extended to send error messages to a configurable eMail address - implements [#53]
172- Added config `'emailAddressOnError'`
173- Added config `'notifyByMailOnSuccess'`
174- Added localizations for error messages
175- Added eMail templates for mail notifications
176- German translations added
177
178
179## [2016-08-14]
180
181### �� Changed
182- Updated last change date to current date - fix [#38]
183
184### �� Fixed
185- Adjusted method signatures to match parent in action/editcommit.php
186- Corrected method signature for php7-compatibility in action/editcommit.php
187
188
189## [2015-10-03]
190
191### �� Added
192- Allow name and mail user variables in addParams.
193- Add an option for customizing git working tree
194- Added setting ignorePaths to ignore specified paths in add/commit-process
195
196### �� Changed
197- Use Markdown for the GitHub README.
198- Update plugin date and URL, added Carsten Teibes as author
199- Pull latest git php library (0.1.4)
200- Allow to set the path to the git binary - implements [#8]
201- Use relative path for Git.php and `$conf['tempdir']` for temp file.
202- Coding compliance change: move handle_periodic_pull down, together with other "handle"s.
203
204### �� Fixed
205- Fix passing additional arguments to git binary
206- Fix lang typos.
207- Coding compliance change, tabs to spaces, fix typos.
208- dokuwiki Farm fix
209
210
211## [2012-10-31]
212
213### �� Added
214- Initial release
215
216### �� Comments
217- The release name complies with the date property of plugin.info.txt
218- The recent commit within this release is [2dbc1a5](https://github.com/woolfg/dokuwiki-plugin-gitbacked/commit/2dbc1a5564516b801dbda239b68152edb5be0303) of 13-Nov-2012
219
220<!--
221## []
222
223### NeverReleased
224- This is just a dummy placeholder to make the parser of GHCICD/release-notes-from-changelog@v1 happy!
225-->
226
227[Unreleased]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2026-02-21..HEAD
228[2026-02-21]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2025-11-11..v2026-02-21
229[2025-11-11]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2025-02-26..v2025-11-11
230[2025-02-26]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2023-05-07..v2025-02-26
231[2023-05-07]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2023-03-07..v2023-05-07
232[2023-03-07]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2022-02-06..v2023-03-07
233[2022-02-06]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2022-01-20..v2022-02-06
234[2022-01-20]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2021-03-19..v2022-01-20
235[2021-03-19]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2016-08-14..v2021-03-19
236[2016-08-14]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2015-10-03..v2016-08-14
237[2015-10-03]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2012-10-31..v2015-10-03
238[2012-10-31]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/releases/tag/v2012-10-31
239[#94]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/pull/94
240[#93]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/pull/93
241[#91]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/pull/91
242[#86]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/86
243[#82]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/82
244[#80]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/80
245[#79]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/79
246[#69]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/69
247[#67]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/67
248[#66]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/66
249[#63]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/63
250[#53]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/53
251[#39]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/39
252[#38]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/38
253[#8]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/8
254