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