xref: /plugin/gitbacked/CHANGELOG.md (revision c365e7db171e13fc94915621164a0270ac12db2e) 
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## [2025-03-03]
69
70### Added
71- Add code style config files
72- Add code style check
73- Add auto loader `loader.php`
74
75### Fixed
76- Replace references to deprecated classes by non deprecated classes
77- Update code to meet DokuWiki standard code style
78- Make use of plugin specific namespace for `classes/*.php` classes
79
80
81## [2025-02-26]
82
83### Added
84- Add config `'updateIndexOnPull'` - PR [#93], [#94]
85
86### Changed
87- Avoid using $_ENV in `lib/Git.php#run_command` - PR [#91]
88  - ensuring more controlled and secure handling of environment variables
89  - fixes probable warning 'Array to string conversion'
90
91
92## [2023-05-07]
93
94### Fixed
95- Deprecation warnings raised on `action/editcommit.php` - fixes [#86]
96
97
98## [2023-03-07]
99
100### Changed
101- Allow absolute path in `'repoPath'` and/or `'repoWorkDir'` - implements [#80]
102- `'repoWorkDir'` is configured empty by default now
103- `--work-tree` option is ommited, if `'repoWorkDir'` is empty - addressing [#79]
104
105### Fixed
106- Cyrillic commit messages not being corrupted anymore - fixes [#82]
107
108
109## [2022-02-06]
110
111### Changed
112- Created LICENSE file and removed corresponding text from the README.md - implements [#67]
113- Use DokuWiki's user name & email address as commit author - implements [#63], [#66]
114  - Updated default setting for `$conf['addParams']` to apply DokuWiki user name as commit author and DokuWiki user eMail as eMail.
115  - If DokuWiki user eMail is empty, then the eMail assigned to the commit will be empty as well.
116- Updated README.md:
117  - Added a link to the referred COPYING license file originally hosted on the DokuWiki master branch to simplify a probable lookup.
118  - Issues linked on startpage, motivate people to contribute
119
120### Fixed
121- Allow empty commits - fixes [#39]
122
123
124## [2022-01-20]
125
126### Fixed
127- Fix for compatibility to PHP versions <7.4 - was introduced by previous release - fixes [#69]
128
129
130## [2021-03-19]
131
132### Added
133- Extended to send error messages to a configurable eMail address - implements [#53]
134- Added config `'emailAddressOnError'`
135- Added config `'notifyByMailOnSuccess'`
136- Added localizations for error messages
137- Added eMail templates for mail notifications
138- German translations added
139
140
141## [2016-08-14]
142
143### Changed
144- Updated last change date to current date - fix [#38]
145
146### Fixed
147- Adjusted method signatures to match parent in action/editcommit.php
148- Corrected method signature for php7-compatibility in action/editcommit.php
149
150
151## [2015-10-03]
152
153### Added
154- Allow name and mail user variables in addParams.
155- Add an option for customizing git working tree
156- Added setting ignorePaths to ignore specified paths in add/commit-process
157
158### Changed
159- Use Markdown for the GitHub README.
160- Update plugin date and URL, added Carsten Teibes as author
161- Pull latest git php library (0.1.4)
162- Allow to set the path to the git binary - implements [#8]
163- Use relative path for Git.php and `$conf['tempdir']` for temp file.
164- Coding compliance change: move handle_periodic_pull down, together with other "handle"s.
165
166### Fixed
167- Fix passing additional arguments to git binary
168- Fix lang typos.
169- Coding compliance change, tabs to spaces, fix typos.
170- dokuwiki Farm fix
171
172
173## [2012-10-31]
174
175### Added
176- Initial release
177
178### Comments
179- The release name complies with the date property of plugin.info.txt
180- The recent commit within this release is [2dbc1a5](https://github.com/woolfg/dokuwiki-plugin-gitbacked/commit/2dbc1a5564516b801dbda239b68152edb5be0303) of 13-Nov-2012
181
182<!--
183## []
184
185### NeverReleased
186- This is just a dummy placeholder to make the parser of GHCICD/release-notes-from-changelog@v1 happy!
187-->
188
189[Unreleased]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2025-03-01..HEAD
190[2025-03-01]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2025-02-26..v2025-03-01
191[2025-02-26]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2023-05-07..v2025-02-26
192[2023-05-07]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2023-03-07..v2023-05-07
193[2023-03-07]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2022-02-06..v2023-03-07
194[2022-02-06]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2022-01-20..v2022-02-06
195[2022-01-20]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2021-03-19..v2022-01-20
196[2021-03-19]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2016-08-14..v2021-03-19
197[2016-08-14]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2015-10-03..v2016-08-14
198[2015-10-03]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/compare/v2012-10-31..v2015-10-03
199[2012-10-31]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/releases/tag/v2012-10-31
200[#94]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/pull/94
201[#93]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/pull/93
202[#91]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/pull/91
203[#86]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/86
204[#82]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/82
205[#80]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/80
206[#79]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/79
207[#69]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/69
208[#67]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/67
209[#66]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/66
210[#63]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/63
211[#53]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/53
212[#39]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/39
213[#38]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/38
214[#8]: https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues/8
215