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