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