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