1*98d82639SMarkus Hoffrogge# Manage Releases 2*98d82639SMarkus Hoffrogge 3*98d82639SMarkus Hoffrogge## Release version naming 4*98d82639SMarkus Hoffrogge- This plugin is provided as released DokuWiki installable ZIP packages with detailed release notes 5*98d82639SMarkus Hoffrogge via this repos [Release](https://github.com/woolfg/dokuwiki-plugin-gitbacked/releases) page. 6*98d82639SMarkus Hoffrogge- The name of a release is identical to the `date` property in `plugin.info.txt` of that release. 7*98d82639SMarkus Hoffrogge 8*98d82639SMarkus Hoffrogge## Pre-Requisites 9*98d82639SMarkus Hoffrogge- The release notes have to be maintained manually in [CHANGELOG.md](https://github.com/woolfg/dokuwiki-plugin-gitbacked/blob/master/CHANGELOG.md) - any details can be found in the comment section within this file. 10*98d82639SMarkus Hoffrogge 11*98d82639SMarkus Hoffrogge## Building a release 12*98d82639SMarkus Hoffrogge- Releases are built by the `build_release.yml` GitHub Action workflow of this project. 13*98d82639SMarkus Hoffrogge- A release build is triggered by applying a tag with name '**v**YYYY-MM-DD' to the corresponding most recent commit of this release. 14*98d82639SMarkus Hoffrogge- The release workflow is not triggered, if: 15*98d82639SMarkus Hoffrogge - The release tag is not of format `v[0-9]+-[0-9]+-[0-9]+` 16*98d82639SMarkus Hoffrogge- The release workflow is failing and no release will be created, if: 17*98d82639SMarkus Hoffrogge - The release version after the 'v'-prefix does not match the `date` property in file `plugin.info.txt` 18*98d82639SMarkus Hoffrogge - The `CHANGELOG.md` does not contain a line of format '# [YYYY-MM-DD]' matching the release version 19*98d82639SMarkus Hoffrogge - The `CHANGELOG.md` does not contain an appropriate compare link versus the previous release version at the end of the `CHANGELOG.md` file 20