1# gitbacked Plugin for DokuWiki 2 3## :green_heart: Contributions welcome :green_heart: 4 5You want to support Open Source, even if you are new to the game? 6Feel free to grab an issue: 7 8- [Smaller issues, also well suited for newcomers](https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues?q=is%3Aissue+is%3Aopen+label%3Acontributionwelcome) 9- [Feature requests and other cool ideas](https://github.com/woolfg/dokuwiki-plugin-gitbacked/issues?q=is%3Aissue+is%3Aopen+label%3A%22feature+request%22) 10 11If you have encountered a problem, you have a good idea, or just have a question, please, create a new issue. 12 13## gitbacked Plugin for DokuWiki 14 15Store/Sync pages and media files in a git repository 16 17All documentation for this plugin can be found at 18http://www.dokuwiki.org/plugin:gitbacked 19 20If you install this plugin manually, make sure it is installed in 21`lib/plugins/gitbacked/` - if the folder is called differently it 22will not work! 23 24Please refer to http://www.dokuwiki.org/plugins for additional info 25on how to install plugins in DokuWiki. 26 27## Release Management 28 29- This plugin is provided as released DokuWiki installable ZIP packages with detailed release notes 30 via this repos [Release](https://github.com/woolfg/dokuwiki-plugin-gitbacked/releases) page. 31- The name of a release is identical to the `date` property in `plugin.info.txt` of that release. 32- Releases are built by the `build_release.yml` GitHub Action workflow of this project. 33- A release build is triggered by applying a tag with name '**v**YYYY-MM-DD' to the corresponding most recent commit of this release. 34- The release workflow is not triggered, if: 35 - The release tag is not of format `v[0-9]+-[0-9]+-[0-9]+` 36- The release workflow is failing and no release will be created, if: 37 - The release version after the 'v'-prefix does not match the `date` property in file `plugin.info.txt` 38 - The `CHANGELOG.md` does not contain a line of format '# [YYYY-MM-DD]' matching the release version 39 - The `CHANGELOG.md` does not contain an appropriate compare link versus the previous release version at the end of the `CHANGELOG.md` file 40- The release notes have to be maintained manually in `CHANGELOG.md` - further details can be found in the comment section within `CHANGELOG.md` 41 42## Maintainers 43 44- [@mhoffrog (Markus Hoffrogge)](https://github.com/mhoffrog) 45- [@woolfg (Wolfgang Gassler)](https://github.com/woolfg) 46 47## License 48 49This plugin is licensed under GPLv2, see [LICENSE](LICENSE). 50 51See the [COPYING](https://github.com/splitbrain/dokuwiki/blob/master/COPYING) file in your DokuWiki folder for details 52 53